-
Notifications
You must be signed in to change notification settings - Fork 122
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: remove tutorial chapters that are covered by the how-to guide #1511
base: main
Are you sure you want to change the base?
docs: remove tutorial chapters that are covered by the how-to guide #1511
Conversation
The k8s-tutorial-sdk repository will also need to be updated, including renaming a bunch of chapters, in sync with this getting merged. I'd suggest that we don't merge this until the Discourse versions go away, if possible, so that the example repo can always match the live version. |
```text | ||
git clone https://github.com/canonical/juju-sdk-tutorial-k8s.git | ||
cd juju-sdk-tutorial-k8s | ||
git checkout 05_preserve_charm_data | ||
git checkout -b 06_create_actions | ||
git checkout 03_integrate_with_psql |
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.
Should we get rid of the "nn_" prefixes on the branch names to avoid having to rename things (more than the once)?
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.
I wondered about that too. Adding (especially inserting) or removing a chapter is annoying, because there's this chunk at the start, plus a similar one at the end, as well as previous/next links - and this repo and the tutorial one need to be kept in sync. I think we can probably automate a bunch of that now that we don't have to work with Discourse.
On the other hand, it is nice to have a clear order, and that's missing from the docs now that they don't have leading numbers. We probably aren't adding/removing pages all that often.
The (k8s) tutorial is currently quite long, and we'd like it to be shorter so that it's easier for charmers to get going.
The plan is that the features described in the tutorial should be the chapters. Namely:
This PR removes the chapters:
There are a few other small tidy-ups, particularly around whitespace and removing old commented text.