Skip to content

installation: re-jig and properly cover distributed installation - #949

Merged
MetRonnie merged 2 commits into
cylc:8.6.xfrom
oliver-sanders:558
Aug 20, 2026
Merged

installation: re-jig and properly cover distributed installation#949
MetRonnie merged 2 commits into
cylc:8.6.xfrom
oliver-sanders:558

Conversation

@oliver-sanders

@oliver-sanders oliver-sanders commented Jul 10, 2026

Copy link
Copy Markdown
Member

An attempt to convert notes from a recent Discourse thread into docs.

@dpmatthews, please could you check the wrapper script side of things.

Requirements check-list

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

@oliver-sanders oliver-sanders added this to the 8.6.x milestone Jul 10, 2026
@oliver-sanders oliver-sanders self-assigned this Jul 10, 2026
@oliver-sanders oliver-sanders added the content Addition or modification of documentation label Jul 10, 2026
Comment thread src/user-guide/cheat-sheet.rst Outdated
Comment thread src/installation.rst
Comment thread src/installation.rst Outdated
Comment thread src/user-guide/cheat-sheet.rst Outdated
Comment thread src/installation.rst Outdated
Comment thread src/installation.rst Outdated

@dpmatthews dpmatthews left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Partial review - mainly the wrapper script side of things

@MetRonnie

Copy link
Copy Markdown
Member

Kicking tests

@MetRonnie MetRonnie closed this Aug 5, 2026
@MetRonnie MetRonnie reopened this Aug 5, 2026
@oliver-sanders

oliver-sanders commented Aug 5, 2026

Copy link
Copy Markdown
Member Author

I appear to have jiggered up something here...

... fixed (indentation error)

@oliver-sanders
oliver-sanders force-pushed the 558 branch 3 times, most recently from a45124c to 44ef475 Compare August 6, 2026 12:38
@MetRonnie

Copy link
Copy Markdown
Member

Genuine linkcheck failure?

( installation: line 319) broken RoseDocumentation -

@oliver-sanders

Copy link
Copy Markdown
Member Author

Hmmm, I don't think it likes __ syntax combined with <placeholders>, fall back to another link.

* Closes cylc#558
* Re-write the installation page.
* Document the wrapper script.
* Document the packages and optional extras provided.
* Cover upgrading Cylc workflows in the cheat sheet.
@oliver-sanders

Copy link
Copy Markdown
Member Author

(fixed linkcheck issue)

@MetRonnie MetRonnie left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

(1 minor grammar suggestion)

Comment thread src/installation.rst Outdated
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
@MetRonnie
MetRonnie merged commit a049eb9 into cylc:8.6.x Aug 20, 2026
2 checks passed
@oliver-sanders
oliver-sanders deleted the 558 branch August 20, 2026 14:23
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants