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

docs: add explanations for how to manage service dependencies #440

Merged
merged 13 commits into from
Aug 8, 2024

Conversation

IronCore864
Copy link
Contributor

@IronCore864 IronCore864 commented Jun 28, 2024

A how-to guide on managing service dependencies.

Preview: https://canonical-pebble--440.com.readthedocs.build/en/440/how-to/service-dependencies/

Note that this PR include changes from #438; to only review the changes on the service dependencies how-to guide, see here.

@IronCore864 IronCore864 requested a review from benhoyt June 28, 2024 02:49
@IronCore864 IronCore864 marked this pull request as ready for review June 28, 2024 02:49
@benhoyt
Copy link
Contributor

benhoyt commented Jul 4, 2024

Note that I've fixed and updated the wording in the README "service dependencies" section -- we may need to update the content in the docs in parallel (till the docs site is published and the old README content is deleted).

Copy link
Contributor

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Structure and approach looks good to me, but I've left a bunch of comments about style and grammar.

docs/how-to/service-dependencies.md Outdated Show resolved Hide resolved
docs/how-to/service-dependencies.md Outdated Show resolved Hide resolved
docs/how-to/service-dependencies.md Outdated Show resolved Hide resolved
docs/how-to/service-dependencies.md Outdated Show resolved Hide resolved
docs/how-to/service-dependencies.md Outdated Show resolved Hide resolved
docs/how-to/service-dependencies.md Outdated Show resolved Hide resolved
docs/how-to/service-dependencies.md Outdated Show resolved Hide resolved
docs/how-to/service-dependencies.md Outdated Show resolved Hide resolved
docs/how-to/service-dependencies.md Outdated Show resolved Hide resolved
docs/how-to/service-dependencies.md Outdated Show resolved Hide resolved
@IronCore864
Copy link
Contributor Author

I have resolved all comments, merged suggestions from both Anne and Ben. See the latest preview here.

@IronCore864
Copy link
Contributor Author

After discussion, we decided to merge Anne's PR first, then add back the removed sections into explanations, which is what this PR now does.

I added the sections into Service dependencies and Service start order, also updated links in the how-to doc.

Please preview the above links and review this PR @benhoyt @AnneCYH.

@IronCore864 IronCore864 changed the title docs: how to manage service dependencies docs: add explanations for how to manage service dependencies Jul 26, 2024
@IronCore864 IronCore864 merged commit 81f57da into canonical:master Aug 8, 2024
16 checks passed
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.

3 participants