Skip to content

Commit a59f50f

Browse files
Minor docs improvements (#1016)
* Don't use 'here' as anchor text (this is bad for accessibility) * Fix a broken Markdown link * Capitalise Markdown and GitHub * Fix an outdated docs link * Specify where on Discourse to post about links, and note that Mattermost should get a notice too
1 parent 7e5e2e8 commit a59f50f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

HACKING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
To work in the framework itself you will need Python >= 3.8. Linting, testing,
44
and docs automation is performed using
5-
[`tox`](https://tox.readthedocs.io/en/latest/) which you should install.
5+
[`tox`](https://tox.readthedocs.io/en/latest/), which you should install.
66
For improved performance on the tests, ensure that you have PyYAML
77
installed with the correct extensions:
88

@@ -23,7 +23,7 @@ tox
2323
tox -e unit
2424
tox -e unit test/test_charm.py
2525

26-
# Format the code using isort
26+
# Format the code using isort and autopep8
2727
tox -e fmt
2828

2929
# Generate a local copy of the Sphinx docs in docs/_build
@@ -53,7 +53,7 @@ pytest
5353
## Pebble Tests
5454

5555
The framework has some tests that interact with a real/live pebble server. To
56-
run these tests, you must have (pebble)[https://github.com/canonical/pebble]
56+
run these tests, you must have [pebble](https://github.com/canonical/pebble)
5757
installed and available in your path. If you have the Go toolchain installed,
5858
you can run `go install github.com/canonical/pebble/cmd/pebble@latest`. This will
5959
install pebble to `$GOBIN` if it is set or `$HOME/go/bin` otherwise. Add
@@ -85,19 +85,19 @@ In general, new functionality
8585
should always be accompanied by user-focused documentation that is posted to
8686
https://juju.is/docs/sdk. The content for this site is written and hosted on
8787
https://discourse.charmhub.io/c/doc. New documentation should get a new
88-
topic/post on this discourse forum and then should be linked into the main
88+
topic/post on this Discourse forum and then should be linked into the main
8989
docs navigation page(s) as appropriate. The ops library's SDK page
9090
content is pulled from
91-
[here](https://discourse.charmhub.io/t/the-charmed-operator-software-development-kit-sdk-docs/4449).
91+
[the corresponding Discourse topic](https://discourse.charmhub.io/t/the-charmed-operator-software-development-kit-sdk-docs/4449).
9292
Each page on [juju.is](https://juju.is/docs/sdk) has a link at the bottom that
93-
takes you to the corresponding discourse page where docs can be commented on
93+
takes you to the corresponding Discourse page where docs can be commented on
9494
and edited (if you have earned those privileges).
9595

9696
The ops library's API reference is automatically built and published to
97-
[here](https://ops.readthedocs.io/en/latest/). Please be complete with
97+
[ops.readthedocs.io](https://ops.readthedocs.io/en/latest/). Please be complete with
9898
docstrings and keep them informative for _users_.
9999

100-
Currently we don't publish separate versions of documentation for separate releases. Instead, new features should be sign-posted like done [here](https://juju.is/docs/sdk/pebble#heading--file-exists) with markdown like this:
100+
Currently we don't publish separate versions of documentation for separate releases. Instead, new features should be sign-posted (for example, as done for [File and directory existence in 1.4](https://juju.is/docs/sdk/interact-with-pebble#heading--file-exists)) with Markdown like this:
101101

102102
```markdown
103103
[note status="version"]1.4[/note]
@@ -117,7 +117,7 @@ are listed in [requirements.txt](requirements.txt).
117117

118118
To make a release of the ops library, do the following:
119119

120-
1. Visit the [releases page on github](https://github.com/canonical/operator/releases).
120+
1. Visit the [releases page on GitHub](https://github.com/canonical/operator/releases).
121121
2. Click "Draft a new release"
122122
3. The "Release Title" is simply the full version number, in the form <major>.<minor>.<patch>
123123
E.g. 2.3.12
@@ -126,8 +126,8 @@ To make a release of the ops library, do the following:
126126

127127
This will trigger an automatic build for the Python package and publish it to PyPI (the API token/secret is already set up in the repository settings).
128128

129-
See [.github/workflows/publish.yml](.github/workflows/publish.yml) for details. (Note that the versions in publish.yml refer to versions of the github actions, not the versions of the ops library.)
129+
See [.github/workflows/publish.yml](.github/workflows/publish.yml) for details. (Note that the versions in publish.yml refer to versions of the GitHub actions, not the versions of the ops library.)
130130

131131
You can troubleshoot errors on the [Actions Tab](https://github.com/canonical/operator/actions).
132132

133-
Announce the release on discourse.
133+
Announce the release on [Discourse](https://discourse.charmhub.io/c/framework/42) and [Mattermost](https://chat.charmhub.io/charmhub/channels/charm-dev)

0 commit comments

Comments
 (0)