You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
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
94
94
and edited (if you have earned those privileges).
95
95
96
96
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
98
98
docstrings and keep them informative for _users_.
99
99
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:
101
101
102
102
```markdown
103
103
[note status="version"]1.4[/note]
@@ -117,7 +117,7 @@ are listed in [requirements.txt](requirements.txt).
117
117
118
118
To make a release of the ops library, do the following:
119
119
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).
121
121
2. Click "Draft a new release"
122
122
3. The "Release Title" is simply the full version number, in the form <major>.<minor>.<patch>
123
123
E.g. 2.3.12
@@ -126,8 +126,8 @@ To make a release of the ops library, do the following:
126
126
127
127
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).
128
128
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.)
130
130
131
131
You can troubleshoot errors on the [Actions Tab](https://github.com/canonical/operator/actions).
132
132
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