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

review CLI and schema docs #4091

Closed
oliver-sanders opened this issue Feb 22, 2021 · 3 comments
Closed

review CLI and schema docs #4091

oliver-sanders opened this issue Feb 22, 2021 · 3 comments
Assignees
Labels
doc Documentation
Milestone

Comments

@oliver-sanders
Copy link
Member

oliver-sanders commented Feb 22, 2021

A lot has changed in Cylc8, we should make a pass through the CLI help to update terminology and make sure nothing has slipped the net.

The Schema docs (used for GraphiQL and the Cylc UI) were largely transferred from the CLI help during earlier Cylc8 development and may have drifted slightly, sometimes purposefully.

Suggest updating the CLI then transferring that across to the Schema. Note that the schema docs are interpreted as markdown.

@oliver-sanders oliver-sanders added the doc Documentation label Feb 22, 2021
@oliver-sanders oliver-sanders added this to the cylc-8.0.0 milestone Feb 22, 2021
@oliver-sanders
Copy link
Member Author

#3340

@wxtim
Copy link
Member

wxtim commented Oct 25, 2021

The CLI docs look OK to me. Are there any particular examples you'd spotted?

I'm not sure that I understand where I'm looking for the schema docs...

@wxtim
Copy link
Member

wxtim commented Nov 12, 2021

This should have been closed by #4473

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

No branches or pull requests

2 participants