Skip to content

Commit 88d5c54

Browse files
authored
Merge pull request #252 from hughrun/main
add v0.8.2 to main
2 parents 5dfd12c + 664ac2c commit 88d5c54

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

content/contributing/documentation.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,7 @@ Locales for the language dropdown are listed in `i18n.py`. Generally we wait for
143143

144144
When a new version of BookWyrm is released we need to create a new version of the docs:
145145

146-
1. Add a new branch with a name exactly matching the new version tag in BookWyrm. e.g. `v0.8.0`.
147-
2. Add that branch name to the list of versions in `generate.py` in the `main` branch of the docs
148-
3. Check out every other version in turn, and merge the updated generation file into it so they all have the new branch listed: `git checkout main generate.py`. Then commit this change, create a PR to merge this change into the version's branch in the docs, and merge it. This will ensure that all pages in all versions of the docs have every other version listed in the dropdown menu.
149-
150-
4. Merge the change in the `main` branch last - only merges into `main` trigger the GitHub action to deploy to the docs web server so if you do this first, the changes in other branches will have no effect.
146+
1. Add a new branch with a name exactly matching the new version tag in BookWyrm. e.g. `v0.x.y`.
147+
2. Add that branch name to the list of versions in `generate.py`, and push your new branch to the repository.
148+
3. Check out every other version in turn, and merge the updated `generate.py` file into it so they all have the new branch listed: `git checkout v0.x.y generate.py`. Then commit this change, create a PR to merge this change into the version's branch in the docs, and merge it. This will ensure that all pages in all versions of the docs have every other version listed in the dropdown menu.
149+
4. Merge the new `generate.py` in the `main` branch last - only merges into `main` trigger the GitHub action to deploy to the docs web server so if you do this first, the changes in other branches will have no effect until next time you update `main`.

generate.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ def format_markdown(file_path):
175175
if not version
176176
else f"/{version}/{SLUG}{output_path}"
177177
)
178-
versions = ["development", "v0.7.5", "v0.8.0"]
178+
versions = ["development", "v0.7.5", "v0.8.0", "v0.8.2"]
179179
current_version = version if version else ""
180180
render_file.write(
181181
template.render(

0 commit comments

Comments
 (0)