Skip to content

Commit f84e5cc

Browse files
committed
Remove references to next in the documentation
Update it to use `v0.1-dev` and `latest-dev` instead. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 859758b commit f84e5cc

File tree

7 files changed

+15
-11
lines changed

7 files changed

+15
-11
lines changed

cookiecutter/hooks/post_gen_project.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def main() -> None:
7575
print("mkdocs serve")
7676
print()
7777
print("To initialize the GitHub pages website:")
78-
print("mike deploy --update-aliases next latest")
78+
print("mike deploy --update-aliases v0.1-dev latest-dev latest")
7979
print("mike set-default latest")
8080
print("git push upstream gh-pages # or origin if you haven't forked the repo")
8181
print()

docs/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -182,11 +182,13 @@ initial setup is needed for it to work correctly:
182182

183183
```sh
184184
pip install -e .[dev-mkdocs] # Not necessary if you already installed .[dev]
185-
mike deploy --update-aliases next latest # Creates the branch gh-pages locally
185+
mike deploy --update-aliases v0.1-dev latest-dev latest # Creates the branch gh-pages locally
186186
mike set-default latest # Makes the latest alias the default version
187187
git push upstream gh-pages # Pushes the new branch upstream to publish the website
188188
```
189189

190+
This assumes your branch is called `v0.x.x` and your first release will be `v0.1.0`.
191+
190192
Then make sure that GitHub Pages is enabled in
191193
`https://github.com/<repo-owner>/<repo-name>/settings/pages`.
192194

@@ -199,9 +201,10 @@ The above commands create a new documentation version using
199201
[Mike](https://pypi.org/project/mike/), which is used to keep multiple versions
200202
of the website.
201203

202-
The new documentation version is called `next`, which is used as the name for
203-
the currently in-development branch. The `next` branch has an alias called
204-
`latest`, which is set as the *default*.
204+
The new documentation version is called `v0.1-dev`, which is used as the name for
205+
the currently in-development branch. The `v0.1-dev` branch has an alias called
206+
`latest-dev` that points to the latest in-development version, and `latest`
207+
alias, which is set as the *default*.
205208

206209
If the website is visited without specifying an explicit version, the `latest`
207210
version will be displayed. It is recommended to point `latest` to the latest
@@ -214,7 +217,8 @@ New versions of the documentation will be automatically generated and published
214217
via GitHub Actions on any push.
215218

216219
If a push is to a branch with semver-like format (vX.Y.Z), then the generated
217-
version will replace the current `next` version.
220+
version will replace the current `vX.Y-dev` version (and `vX-dev` and
221+
`latest-dev` alias).
218222

219223
If a tag is pushed instead, then the generated version will replace the current
220224
`vX.Y` version (if there was any), and the aliases `vX` and `latest` will be

tests_golden/integration/test_cookiecutter_generation/actor/cookiecutter-stdout.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ pip install .[dev-mkdocs]
4343
mkdocs serve
4444

4545
To initialize the GitHub pages website:
46-
mike deploy --update-aliases next latest
46+
mike deploy --update-aliases v0.1-dev latest-dev latest
4747
mike set-default latest
4848
git push upstream gh-pages # or origin if you haven't forked the repo
4949

tests_golden/integration/test_cookiecutter_generation/api/cookiecutter-stdout.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pip install .[dev-mkdocs]
4242
mkdocs serve
4343

4444
To initialize the GitHub pages website:
45-
mike deploy --update-aliases next latest
45+
mike deploy --update-aliases v0.1-dev latest-dev latest
4646
mike set-default latest
4747
git push upstream gh-pages # or origin if you haven't forked the repo
4848

tests_golden/integration/test_cookiecutter_generation/app/cookiecutter-stdout.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pip install .[dev-mkdocs]
4242
mkdocs serve
4343

4444
To initialize the GitHub pages website:
45-
mike deploy --update-aliases next latest
45+
mike deploy --update-aliases v0.1-dev latest-dev latest
4646
mike set-default latest
4747
git push upstream gh-pages # or origin if you haven't forked the repo
4848

tests_golden/integration/test_cookiecutter_generation/lib/cookiecutter-stdout.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pip install .[dev-mkdocs]
4242
mkdocs serve
4343

4444
To initialize the GitHub pages website:
45-
mike deploy --update-aliases next latest
45+
mike deploy --update-aliases v0.1-dev latest-dev latest
4646
mike set-default latest
4747
git push upstream gh-pages # or origin if you haven't forked the repo
4848

tests_golden/integration/test_cookiecutter_generation/model/cookiecutter-stdout.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pip install .[dev-mkdocs]
4242
mkdocs serve
4343

4444
To initialize the GitHub pages website:
45-
mike deploy --update-aliases next latest
45+
mike deploy --update-aliases v0.1-dev latest-dev latest
4646
mike set-default latest
4747
git push upstream gh-pages # or origin if you haven't forked the repo
4848

0 commit comments

Comments
 (0)