Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
D
dorie
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 31
    • Issues 31
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 9
    • Merge Requests 9
  • Operations
    • Operations
    • Incidents
    • Environments
  • Analytics
    • Analytics
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
  • dorie
  • dorie
  • Merge Requests
  • !175

Merged
Opened Nov 18, 2019 by Lukas Riedel@lriedel🛀Owner5 of 5 tasks completed5/5 tasks

Resolve "Add XML version tags to config file parameter docs"

  • Overview 1
  • Commits 6
  • Pipelines 3
  • Changes 9

What does this MR do?

Add version information to the XML source files of the default config files. I added the tag versionadded where a new parameter was created and versionchanged if the parameter "location" in the parameter tree was changed. I also added a general note on the parameter file structure in the user docs (adapting these version number occurances is now also mentioned in the GitLab Description Templates).

The version change data is now written into the .rst files with the appropriate Sphinx directives. The data is ordered by decreasing version number, that is, the most recent version is listed first.

Additionally, the write_config wrapper now always throws if an error occurs. Before, it would only throw if the .ini files could not be written.

Is there something that needs to be double checked?

No.

Can this MR be accepted?

  • Added/Updated documentation
  • Pipeline passing
  • Squash option set
  • Delete branch option set
  • Added entry to CHANGELOG.md

Assignee: If the Squash option is set, check/update the commit message right before merging!

Related issues

Closes #167 (closed)

Edited Nov 19, 2019 by Lukas Riedel
Assignee
Assign to
Reviewer
Request review from
v2.0 Release
Milestone
v2.0 Release
Assign milestone
Time tracking
Reference: dorie/dorie!175
Source branch: 167-add-xml-version-tags-to-config-file-parameter-docs

Revert this merge request

This will create a new commit in order to revert the existing changes.

Switch branch
Cancel
A new branch will be created in your fork and a new merge request will be started.

Cherry-pick this merge request

Switch branch
Cancel
A new branch will be created in your fork and a new merge request will be started.