Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "changed in version x.y.z" notes to config descriptions #4342

Closed
MetRonnie opened this issue Aug 5, 2021 · 7 comments · Fixed by #4473
Closed

Add "changed in version x.y.z" notes to config descriptions #4342

MetRonnie opened this issue Aug 5, 2021 · 7 comments · Fixed by #4473
Assignees
Labels
config change Involves a change to global or workflow config doc Documentation small
Milestone

Comments

@MetRonnie
Copy link
Member

cylc-sphinx-extensions provides prominent versionchanged labels which would be nice to use in the workflow and global config docs, in order to bring attention to changes.

https://cylc.github.io/cylc-sphinx-extensions/extensions/cylc.sphinx_ext.rtd_theme_addons.html#module-cylc.sphinx_ext.rtd_theme_addons

Pull requests welcome!

@MetRonnie MetRonnie added the doc Documentation label Aug 5, 2021
@MetRonnie MetRonnie added this to the cylc-8.0.0 milestone Aug 5, 2021
@oliver-sanders
Copy link
Member

Yes please!

Was going to raise this on the 8.x timeframe, however, it would be good to mark any configurations which have changed between versions 7 and 8 as "changed in version 8.0.0".

@MetRonnie MetRonnie added the config change Involves a change to global or workflow config label Aug 9, 2021
@wxtim wxtim self-assigned this Aug 24, 2021
@wxtim
Copy link
Member

wxtim commented Aug 24, 2021

note to self

   .. versionchanged:: 1.2.3

      Something changed!

@wxtim
Copy link
Member

wxtim commented Aug 25, 2021

This looks fairly horrible to do in practice in terms of trawling through the history. I'm going to make a PR for all the changes I can remember making, especially focusing on Cylc 8 changes. IMO the really important places to put these labels are on changes that are being made from now on.

I think that it might be easier to pass this issue around everyone whose made changes, because it'll be easier do to your own changes.

@MetRonnie
Copy link
Member Author

There is also

.. versionadded:: 8.0.0

which results in

New in version 8.0.0.

@wxtim
Copy link
Member

wxtim commented Aug 25, 2021

Look at

@hjoliver
Copy link
Member

hjoliver commented Sep 22, 2021

Meeting: move to general doc overhaul (Issue "review CLI and schema and stuff") - go through and do the lot at once.

@oliver-sanders
Copy link
Member

(I.E. It would be easiest to do this along with #4091)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
config change Involves a change to global or workflow config doc Documentation small
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants