Skip to content

The order of tutorials has gotten a bit confused. #924

@samuel-denton

Description

@samuel-denton

The tutorials under the configuration-consolidation section were re-worked slightly but at the same time, the order was changed. It seems like there is some confusion now as to the intended order. As some of the tutorials continue work on the same file, this makes it hard to follow.

Currently, the order of the tutorials, including the precursors to configuration-consolidation, are listed as:

datetime-cycling (previous section) > runtime-configuration (previous section) > JinJa2 > Families > Parameters

However, at the top of both the Families and Parameters tutorials, it states:

This practical continues on from the jinja2 practical

Additionally, during the JinJa2 tutorial, the flow.cylc file being worked on is altered to replace resolution = 0.2 with resolution = {{ RESOLUTION }} with a JinJa2 variable set at the start. This change is intended to continue onto the next tutorial for Families, and the help text for the tutorial suggests as much. However, running cylc get-resources tutorial/consolidation-tutorial currently serves a previous version of the tutorial which does not include the JinJa2 resolution variable change.

It seems @MetRonnie corrected this here, which adds the JinJa2 resolution variable to the Families tutorial, however, that change is not yet live and it still leaves a question as to the final ordering.

Discussing with @oliver-sanders, he thinks the order should be reverted to:
datetime-cycling (previous section) > runtime-configuration (previous section) > Families > JinJa2 > Parameters

and then fix the

This practical continues on from the xyz...

lines to be accurate.

I believe to achieve this I need to:

  1. Re-order the toctree on cylc-doc in all places to: Families > JinJa2 > Parameters (will be sorted in Various small proposed improvements #909)
  2. Update the Tutorial text on cylc-doc to not show JinJa2 being used for resolution in the Families tutorial (will be sorted in Various small proposed improvements #909)
  3. Update this file reverting the PR here so resolution is no longer set by JinJa2
  4. Re-do the JinJa2 tutorial so it makes sense following the Families tutorial
  5. Re-do the Parameters tutorial so it makes sense following the changes to Families and JinJa2 tutorials

Metadata

Metadata

Assignees

Labels

contentAddition or modification of documentation

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions