-
Notifications
You must be signed in to change notification settings - Fork 121
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
docs: add top-level intro and module-level intros #1320
Conversation
84a5f60
to
5665cfb
Compare
644ee51
to
4d9234f
Compare
4d9234f
to
cf841cc
Compare
Also fixes #1263 |
@tmihoc the PR is mostly ready for your review. |
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 good, just two more minor suggestions, but I'm happy to merge. Thanks!
I was looking at the published result and just noticed that, while the top-level intro starts with
(To clarify, I'm not suggesting we change anything about the text on https://ops.readthedocs.io/en/latest/#ops.Framework -- just the order of the ops.main entrypoint vs. ops module.) Sorry I only noticed now. |
@benhoyt noticed this in #1381 as well, so I've adjusted it there. We went with |
While that's true, in principle, content should always have an obvious order, either natural (numerical, for tightly ordered things, or lifecycle, for more loosely ordered things) or, if that's not possible alphabetical. Here I'd use natural order at the high levels and alphabetical within. So,
So that's the order I would use. That is, imo, the fact that ops.main entrypoint is something you only use once shouldn't affect placement. |
Docs: Ops: Add top-level intro, clean up ops.module intro in light of that, flesh out ops.pebble and ops.testing intros a bit more https://warthogs.atlassian.net/browse/CHARMTECH-183 - [x] "home page" library reference - [x] ops module - [x] ops.main entry point - [x] ops.pebble module - [x] ops.testing module
Docs: Ops: Add top-level intro, clean up ops.module intro in light of that, flesh out ops.pebble and ops.testing intros a bit more https://warthogs.atlassian.net/browse/CHARMTECH-183 - [x] "home page" library reference - [x] ops module - [x] ops.main entry point - [x] ops.pebble module - [x] ops.testing module
Docs: Ops: Add top-level intro, clean up ops.module intro in light of that, flesh out ops.pebble and ops.testing intros a bit more https://warthogs.atlassian.net/browse/CHARMTECH-183 - [x] "home page" library reference - [x] ops module - [x] ops.main entry point - [x] ops.pebble module - [x] ops.testing module
Docs: Ops: Add top-level intro, clean up ops.module intro in light of that, flesh out ops.pebble and ops.testing intros a bit more
https://warthogs.atlassian.net/browse/CHARMTECH-183