Skip to content

Additions to and reordering of tutorial bullet points#907

Merged
samuel-denton merged 8 commits intocylc:masterfrom
samuel-denton:batch1_thought_on_docs
Feb 4, 2026
Merged

Additions to and reordering of tutorial bullet points#907
samuel-denton merged 8 commits intocylc:masterfrom
samuel-denton:batch1_thought_on_docs

Conversation

@samuel-denton
Copy link
Contributor

@samuel-denton samuel-denton commented Feb 3, 2026

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.

I have suggested a slight change in the order of bullet points as well as a few additions.
In my opinion, the bullets read better in this order, however, visually I prefer them ordered by line length as previous.

Original:
image

My order with additions:
image

Length order with additions:
image

(This is intentionally a small PR with minimal changes to test my Git procedure)

@samuel-denton samuel-denton requested a review from wxtim February 3, 2026 13:55
@samuel-denton samuel-denton added content Addition or modification of documentation small tutorials labels Feb 3, 2026
@wxtim
Copy link
Member

wxtim commented Feb 3, 2026

Test failures caused by changes to Cylc UI-server


.. ifnotslides::

* :cylc:conf:`flow.cylc` files are divided into sections, written inside square
Copy link
Member

@wxtim wxtim Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that this ordering, referencing the overall structure of the flow.cylc file is more helpful here - @oliver-sanders - what do you think?

passX
passphrase
passwordless
pdf
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These words are now used in Cylc UIS docs.

Copy link
Member

@wxtim wxtim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with this, but I'd like @oliver-sanders to have a quick glance at the re-ordering of the list in graphing.rst.

@wxtim wxtim requested a review from oliver-sanders February 3, 2026 14:50
Co-authored-by: Tim Pillinger <26465611+wxtim@users.noreply.github.com>
@samuel-denton
Copy link
Contributor Author

Having seen issue #124 I wonder if the section names should be:

 :cylc:conf:`[scheduling]`

Instead of:

``[scheduling]``

Co-authored-by: Oliver Sanders <oliver.sanders@metoffice.gov.uk>
@samuel-denton samuel-denton merged commit 7b1e652 into cylc:master Feb 4, 2026
2 checks passed
@samuel-denton samuel-denton deleted the batch1_thought_on_docs branch February 4, 2026 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Addition or modification of documentation small tutorials

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants