-
Notifications
You must be signed in to change notification settings - Fork 94
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
Conversation
@matthewrmshin - this is documentation only (albeit quite a lot of it) - but assign a 2nd review if you like. |
(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) |
There was a problem hiding this 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 bygit status
? doc/index.html
no longer works after this change. Can we have it redirect or else?
Done
That file should no longer exist. All the generated files should end up here:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to go.
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.