Skip to content

Commit 62dc698

Browse files
authored
Change edit_uri default branch to v0.x.x in mkdocs.yml (#311)
2 parents e2a84dc + c94107e commit 62dc698

File tree

12 files changed

+18
-17
lines changed

12 files changed

+18
-17
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
* API projects don't include the `google-common-protos` dependency by default.
2323
* API projects updated the `grpcio` dependency to `1.66.1`.
2424
* API projects updated the `frequenz-api-common` dependency to `0.6`.
25+
* Change `edit_uri` default branch to v0.x.x in mkdocs.yml.
2526

2627
## Bug Fixes
2728

cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ site_author: "{{cookiecutter.author_name}}"
88
copyright: "Copyright © {{copyright_year}} {{cookiecutter.author_name}}"
99
repo_name: "{{cookiecutter.github_repo_name}}"
1010
repo_url: "https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.github_repo_name}}"
11-
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
11+
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
1212
# if the project uses a different default branch.
13-
edit_uri: "edit/main/docs/"
13+
edit_uri: "edit/v0.x.x/docs/"
1414
strict: true # Treat warnings as errors
1515

1616
# Build directories

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here
1717
./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
1818
./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links
19-
./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
19+
./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
2020
./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
2121
./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
2222
./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
88
copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
99
repo_name: "frequenz-actor-test"
1010
repo_url: "https://github.com/frequenz-floss/frequenz-actor-test"
11-
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
11+
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
1212
# if the project uses a different default branch.
13-
edit_uri: "edit/main/docs/"
13+
edit_uri: "edit/v0.x.x/docs/"
1414
strict: true # Treat warnings as errors
1515

1616
# Build directories

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here
1717
./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
1818
./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links
19-
./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
19+
./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
2020
./proto/frequenz/api/test/test.proto:// TODO(cookiecutter): Add a more descriptive package description.
2121
./proto/frequenz/api/test/test.proto:// TODO(cookiecutter): Remove this message.
2222
./py/frequenz/api/test/__init__.py:TODO(cookiecutter): Add a more descriptive module description.

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
88
copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
99
repo_name: "frequenz-api-test"
1010
repo_url: "https://github.com/frequenz-floss/frequenz-api-test"
11-
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
11+
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
1212
# if the project uses a different default branch.
13-
edit_uri: "edit/main/docs/"
13+
edit_uri: "edit/v0.x.x/docs/"
1414
strict: true # Treat warnings as errors
1515

1616
# Build directories

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here
1616
./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
1717
./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links
18-
./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
18+
./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
1919
./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
2020
./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
2121
./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
88
copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
99
repo_name: "frequenz-app-test"
1010
repo_url: "https://github.com/frequenz-floss/frequenz-app-test"
11-
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
11+
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
1212
# if the project uses a different default branch.
13-
edit_uri: "edit/main/docs/"
13+
edit_uri: "edit/v0.x.x/docs/"
1414
strict: true # Treat warnings as errors
1515

1616
# Build directories

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here
1616
./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
1717
./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links
18-
./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
18+
./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
1919
./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
2020
./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
2121
./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
88
copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
99
repo_name: "frequenz-test-python"
1010
repo_url: "https://github.com/frequenz-floss/frequenz-test-python"
11-
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
11+
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
1212
# if the project uses a different default branch.
13-
edit_uri: "edit/main/docs/"
13+
edit_uri: "edit/v0.x.x/docs/"
1414
strict: true # Treat warnings as errors
1515

1616
# Build directories

0 commit comments

Comments
 (0)