Skip to content

Commit 2639538

Browse files
Update release checklist for new archived docs strategy
1 parent 40534ef commit 2639538

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

RELEASE.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,9 @@
132132
5. Remove duplicate words and sort alphabetically via:
133133
`sort -u -o docs/source/spelling_false_positives.txt docs/source/spelling_false_positives.txt`
134134

135-
- [ ] Create an archived copy of the documentation:
135+
- [ ] For major or epoch releases *only* (i.e. not minor, see the versioning strategy at
136+
https://ncas-cms.github.io/cf-python/releases.html#versioning-strategy)
137+
create an archived copy of the documentation:
136138

137139
```bash
138140
./release_docs archive
@@ -181,9 +183,9 @@
181183

182184
- [ ] Upload the new release to Zenodo: https://zenodo.org/record/3961353
183185

184-
- [ ] Copy the archive docs to https://github.com/NCAS-CMS/cf-python-docs
185-
186-
- [ ] Move and commit the previously-generated archived copy of the documentation to https://github.com/NCAS-CMS/cf-python-docs (fork or clone that repo first):
186+
- [ ] For major or epoch releases *only*, move the archive docs generated earlier to
187+
https://github.com/NCAS-CMS/cf-python-docs and commit them (you may have to
188+
fork or clone that repo first):
187189

188190
```bash
189191
mv docs/<vn>/ ~/cf-python-docs/

0 commit comments

Comments
 (0)