Skip to content

Commit

Permalink
improving language around documentation with new releases
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf committed Feb 2, 2018
1 parent 225476c commit 8d2cc3d
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ development.
## Releasing a new version of the helm chart

The following steps can be followed to release a new version of the Helm Chart.
This should happen approximately once every 5-7 weeks.
Presently, we expect a release approximately every 5-7 weeks.


### Create an issue for the new release

Expand All @@ -77,19 +78,27 @@ Below is the checklist for this release.
- [ ] Make a CHANGELOG
- [ ] Generate and add the list of contributors
- [ ] Build and push a new Docker image to DockerHub
- [ ] Commit version bump in `Chartyaml` and `Values.yaml`
- [ ] Commit version bump in `Chart.yaml` and `Values.yaml`
- [ ] Update references in documentation to the new version
- [ ] Confirm that a new deployment using the updated instructions works
- [ ] Create and push a new tag for this release
- [ ] Create and publish a new GitHub release
- [ ] Write / publish a blog post based largely off of the CHANGELOG
- [ ] Set ReadTheDocs to begin using `latest` by default
- [ ] Wait at least several days
- [ ] Spot-check any remaining documentation improvements
- [ ] Celebrate!
```
As there are often many documentation improvements following the release of
a new version, we set ReadTheDocs to serve `latest/` until the first docs are
written that are next-version-specific. As soon as documentation must be
written for the **next** version of the Helm Chart, you can use the following
checklist:
```
- [ ] Create a new tag for a documentation release (same release name with `-doc` at the end)
- [ ] Publish this tag
- [ ] Set ReadTheDocs to point to the new tag by default instead of `latest`
- [ ] Celebrate!
- [ ] Set ReadTheDocs to point to the **new tag** by default instead of `latest`
- [ ] Continue making next-version-specific changes to the documentation.
```
### Make a CHANGELOG
Expand Down Expand Up @@ -118,7 +127,7 @@ involved:
* [JupyterHub](https://github.com/jupyterhub/jupyterhub)
* [OAuthenticator](https://github.com/jupyterhub/oauthenticator))
edit `contributors.py` to have the appropriate dates
Edit `contributors.py` to have the appropriate dates
for each of these versions. Then, run the script and paste
the output into the changelog. For an
example, see [the v0.5 list of contributors](https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/v0.5/CHANGELOG.md#contributors).
Expand Down

0 comments on commit 8d2cc3d

Please sign in to comment.