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.

Sign up for GitHub

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

Jump to bottom

added a guide to writing a platform configuration. #289

Merged
merged 21 commits into from
Oct 13, 2021
Merged

added a guide to writing a platform configuration. #289

merged 21 commits into from
Oct 13, 2021

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented Aug 26, 2021 •
edited
Loading

Partially closes #254
Explains so example platform configurations.

Other bits

@wxtim wxtim added the content Addition or modification of documentation label Aug 26, 2021
@wxtim wxtim self-assigned this Aug 26, 2021
@wxtim wxtim added this to the 8.0.0 milestone Aug 26, 2021
hjoliver
hjoliver reviewed Sep 3, 2021
View reviewed changes
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

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

LTGM thanks @wxtim just a few minor spelling corrections etc.

src/admin-guide/writing-global-configurations/platforms.rst Outdated Show resolved Hide resolved
src/admin-guide/writing-global-configurations/platforms.rst Outdated Show resolved Hide resolved
src/admin-guide/writing-global-configurations/platforms.rst Outdated Show resolved Hide resolved
src/admin-guide/writing-global-configurations/platforms.rst Outdated Show resolved Hide resolved
src/admin-guide/writing-global-configurations/platforms.rst Outdated Show resolved Hide resolved
src/admin-guide/writing-global-configurations/platforms.rst Outdated Show resolved Hide resolved
src/admin-guide/writing-global-configurations/platforms.rst Outdated Show resolved Hide resolved
src/admin-guide/writing-global-configurations/platforms.rst Outdated Show resolved Hide resolved
src/admin-guide/writing-global-configurations/platforms.rst Outdated Show resolved Hide resolved
src/admin-guide/writing-global-configurations/platforms.rst Outdated Show resolved Hide resolved
@wxtim @hjoliver
Apply suggestions from code review
c9c9e6f 
Co-authored-by: Hilary James Oliver <[email protected]>
@wxtim wxtim requested a review from hjoliver September 3, 2021 06:53
@wxtim
Copy link
Member Author

wxtim commented Sep 3, 2021

I think I'm going to have another go at finding a spellchecker for sphinx. This is embarrassing.

@wxtim wxtim mentioned this pull request Sep 6, 2021
Merged
wxtim added 2 commits September 7, 2021 16:30
@wxtim
reconfigured to be in the reference section
f4ff67c
@wxtim
Merge branch 'document.platform.setup' of github.com:wxtim/cylc-doc i…
fd4cc17 
…nto document.platform.setup

* 'document.platform.setup' of github.com:wxtim/cylc-doc:
  Update src/admin-guide/writing-global-configurations/platforms.rst
  Update src/admin-guide/writing-global-configurations/platforms.rst
  Apply suggestions from code review
oliver-sanders
oliver-sanders reviewed Sep 8, 2021
View reviewed changes
Copy link
Member

@oliver-sanders oliver-sanders left a comment

Choose a reason for hiding this comment

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

Thanks Tim 👍

Would be good to have a really simple example of a remote platform too, good chance to introduce the install target before it gets conflated with batch systems.

src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
@wxtim wxtim force-pushed the document.platform.setup branch from 0970a34 to c6fa66e Compare September 9, 2021 09:33
@wxtim wxtim requested a review from oliver-sanders September 9, 2021 09:33
hjoliver
hjoliver approved these changes Sep 9, 2021
View reviewed changes
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

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

Built and read, looks really good 👍

Might need links from other places that reference platforms? (But we need to do a full read-through to check cross-referencing for everything, so no biggie here).

src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
@wxtim
Copy link
Member Author

wxtim commented Sep 10, 2021 •
edited
Loading

Might need links from other places that reference platforms? (But we need to do a full read-through to check cross-referencing for everything, so no biggie here).

Easier to do now IMO ... but, with the caveat that platforms are meant to make things easier for the user by putting moving parts into a black box labelled "Cylc Site Administrator". I don't think we want to over-reference this page.

I've just had a quick look and added a link.

@wxtim
added a reference to the new writing platforms
442b59e
@wxtim
Merge branch 'document.platform.setup' of github.com:wxtim/cylc-doc i…
4e0ca1b 
…nto document.platform.setup

* 'document.platform.setup' of github.com:wxtim/cylc-doc:
  Update src/reference/config/writing-platform-configs.rst
@wxtim
document graph line continuation on boolean
dc8605e
@wxtim
work in progress
e29dbd9
@wxtim wxtim mentioned this pull request Sep 22, 2021
Merged
9 tasks
@wxtim wxtim requested review from datamel and oliver-sanders and removed request for oliver-sanders October 1, 2021 10:09
@wxtim wxtim marked this pull request as draft October 1, 2021 16:28
@wxtim
Copy link
Member Author

wxtim commented Oct 1, 2021

Converted this back to draft. It might as well wait until Platform from group goes in, and I can just uncomment that stuff.

@wxtim wxtim mentioned this pull request Oct 1, 2021
Merged
7 tasks
@wxtim wxtim marked this pull request as ready for review October 5, 2021 14:26
@wxtim wxtim removed the request for review from oliver-sanders October 5, 2021 14:26
@wxtim wxtim mentioned this pull request Oct 5, 2021
Closed
datamel
datamel approved these changes Oct 5, 2021
View reviewed changes
Copy link
Contributor

@datamel datamel left a comment

Choose a reason for hiding this comment

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

A few style comments to bring in line with other documentation. Otherwise, looks good!
Thanks @wxtim.

src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
src/reference/config/writing-platform-configs.rst Outdated Show resolved Hide resolved
@wxtim wxtim requested a review from oliver-sanders October 6, 2021 08:40
@wxtim
Copy link
Member Author

wxtim commented Oct 6, 2021

Would be good to have a really simple example of a remote platform too, good chance to introduce the install target before it gets conflated with batch systems.

I have 2 approvals - Might I just ask @oliver-sanders to double check that this diff 8474281 answers his point.

@wxtim wxtim merged commit eccd12a into cylc:master Oct 13, 2021
@wxtim wxtim deleted the document.platform.setup branch October 13, 2021 09:53
@wxtim wxtim mentioned this pull request Oct 15, 2021
Closed
@MetRonnie MetRonnie modified the milestones: 8.0rc1, 8.0b3 Nov 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hjoliver hjoliver hjoliver approved these changes

@datamel datamel datamel approved these changes

@oliver-sanders oliver-sanders Awaiting requested review from oliver-sanders

Assignees

@wxtim wxtim

Labels
content Addition or modification of documentation
Projects
None yet
Milestone
8.0b3
Development

Successfully merging this pull request may close these issues.

platforms: example platform configurations
5 participants
@wxtim @hjoliver @oliver-sanders @datamel @MetRonnie