docs: add how-to subcategory for managing containers#2309
docs: add how-to subcategory for managing containers#2309dwilding merged 14 commits intocanonical:mainfrom
Conversation
james-garner-canonical
left a comment
There was a problem hiding this comment.
The changes look good to me. I like the new page and organisation.
The duplication seems fine to me -- would be kind of nice if the two pages somehow pulled in the same snippet, but ultimately not worth the effort with our current tooling.
Nice catch in the test.
I'm trusting that the other content is all just moving around, as you said.
tonyandrewmeyer
left a comment
There was a problem hiding this comment.
Sorry for the slow review here - I've read through it (although, like James, I'm generally trusting that the moved content is just moved) and it reads well to me. Only one very small suggestion.
This PR splits [How to run workloads with a Kubernetes charm](https://documentation.ubuntu.com/ops/latest/howto/run-workloads-with-a-charm-kubernetes/) into a subcategory of the how-to guides. I've redistributed all the content without making significant changes. We can do further improvements in follow-on PRs. Main parts to focus on reviewing: - The introductory descriptions on [Manage containers](https://canonical-ubuntu-documentation-library--2309.com.readthedocs.build/ops/2309/howto/manage-containers/) and the scope of each page in that subcategory. I moved "Manage Pebble metrics" into this subcategory because I feel it fits better here, rather than as a top-level how-to guide (this move isn't in the plan I prepared internally). - The same descriptions at [How-to guides > Managing containers](https://canonical-ubuntu-documentation-library--2309.com.readthedocs.build/ops/2309/howto/#managing-containers). I'm copying the approach of "Legacy guides" - listing each of the pages in the subcategory instead of only listing the subcategory itself. I'm open to changing the approach if we don't like the duplication. I also fixed `test_add_layer()` in [How-to guides > Manage the workload container > Write unit tests](https://canonical-ubuntu-documentation-library--2309.com.readthedocs.build/ops/2309/howto/manage-containers/manage-the-workload-container/#write-unit-tests). The test previously defined `container` but used `container_in`. I've switched the test to use `container_in` and `container_out` for clarity.
|
I set up the following redirects in the Read the Docs project:
|
This PR splits How to run workloads with a Kubernetes charm into a subcategory of the how-to guides. I've redistributed all the content without making significant changes. We can do further improvements in follow-on PRs.
Main parts to focus on reviewing:
The introductory descriptions on Manage containers and the scope of each page in that subcategory. I moved "Manage Pebble metrics" into this subcategory because I feel it fits better here, rather than as a top-level how-to guide (this move isn't in the plan I prepared internally).
The same descriptions at How-to guides > Managing containers. I'm copying the approach of "Legacy guides" - listing each of the pages in the subcategory instead of only listing the subcategory itself. I'm open to changing the approach if we don't like the duplication.
I also fixed
test_add_layer()in How-to guides > Manage the workload container > Write unit tests. The test previously definedcontainerbut usedcontainer_in. I've switched the test to usecontainer_inandcontainer_outfor clarity.