docs: fix broken links and use cross references instead of absolute links #1519
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dwilding
changed the title
benhoyt
approved these changes
Jan 8, 2025
tonyandrewmeyer
approved these changes
Jan 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses #1506
Changes that affect the published docs
Fixed links that broke after the library docs were moved under Reference. See 8d62861 (for Harness-related links) and 1d8374e (for other links). For some of the Harness-related links, I set the links to use the full doc title "ops.testing.Harness (legacy unit testing)" to help emphasise that Harness is legacy.
In How to run workloads with a charm - Kubernetes, fixed a link to
ops.Container.isdir. See b5d5528In Manage relations, fixed a link to
ops.RelationChangedEvent. See a2e84e9Changes that affect the doc source only
Replaced absolute links to
ops.testingby a cross reference to the ops.testing page. See a375749. The .rst source for this page defines a reference calledops_testing, so I've used this format for links from .md pages:Replaced links to classes, methods, etc by cross references. See:
ops.testingops.pebbleops.ContainerReferences like
ops.foo.barare generated byautomodule/autoclassdirectives in the .rst source files. If a link doesn't need custom link text, we automatically get code font when doing[](ops.foo.bar)in .md files.