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

Added suite design guide, tidied doc directories. #2211

Merged
merged 5 commits into from
Mar 23, 2017

Conversation

hjoliver
Copy link
Member

@hjoliver hjoliver commented Mar 22, 2017

As discussed with @dpmatthews and @arjclark - this adds the new Suite Design Best Practice Guide to Cylc, and reformulates doc/Makefile to handle that as well.

Also removes the now-obsolete "Suite Design Guidelines" and "Style Guide" sections from the user guide.

@hjoliver
Copy link
Member Author

@matthewrmshin - this is documentation only (albeit quite a lot of it) - but assign a 2nd review if you like.

@hjoliver
Copy link
Member Author

(Matt, you probably don't need to review the new document - it has been reviewed at length by Dave, Andy, and others, over the course of ~3 months ... in case you're not aware of that)

Copy link
Contributor

@matthewrmshin matthewrmshin left a comment

Choose a reason for hiding this comment

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

Looks OK. 2 minor issues:

  • Can we ensure that the items that are created by make are ignored by git status?
  • doc/index.html no longer works after this change. Can we have it redirect or else?

@hjoliver
Copy link
Member Author

Can we ensure that the items that are created by make are ignored by git status?

Done

doc/index.html no longer works after this change. Can we have it redirect or else?

That file should no longer exist. All the generated files should end up here:

$ ls -1F doc/install/
cylc-user-guide.pdf
graphics/
html/
index.css
index.html
suite-design-guide.pdf

@hjoliver hjoliver added this to the soon milestone Mar 23, 2017
@hjoliver hjoliver modified the milestones: next release, soon Mar 23, 2017
Copy link
Contributor

@matthewrmshin matthewrmshin left a comment

Choose a reason for hiding this comment

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

Good to go.

@hjoliver hjoliver merged commit 1760877 into cylc:master Mar 23, 2017
@hjoliver hjoliver deleted the doc-refactor branch March 23, 2017 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants