Skip to content

Commit

Permalink
Change edit_uri default branch to v0.x.x in mkdocs.yml
Browse files Browse the repository at this point in the history
Signed-off-by: cwasicki <126617870+cwasicki@users.noreply.github.com>
Co-authored-by: Leandro Lucarella <luca-frequenz@llucax.com>
  • Loading branch information
cwasicki and llucax committed Oct 3, 2024
1 parent aa30a79 commit c94107e
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 17 deletions.
1 change: 1 addition & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
* API projects don't include the `google-common-protos` dependency by default.
* API projects updated the `grpcio` dependency to `1.66.1`.
* API projects updated the `frequenz-api-common` dependency to `0.6`.
* Change `edit_uri` default branch to v0.x.x in mkdocs.yml.

## Bug Fixes

Expand Down
4 changes: 2 additions & 2 deletions cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ site_author: "{{cookiecutter.author_name}}"
copyright: "Copyright © {{copyright_year}} {{cookiecutter.author_name}}"
repo_name: "{{cookiecutter.github_repo_name}}"
repo_url: "https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.github_repo_name}}"
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
# if the project uses a different default branch.
edit_uri: "edit/main/docs/"
edit_uri: "edit/v0.x.x/docs/"
strict: true # Treat warnings as errors

# Build directories
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here
./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links
./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
repo_name: "frequenz-actor-test"
repo_url: "https://github.com/frequenz-floss/frequenz-actor-test"
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
# if the project uses a different default branch.
edit_uri: "edit/main/docs/"
edit_uri: "edit/v0.x.x/docs/"
strict: true # Treat warnings as errors

# Build directories
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here
./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links
./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
./proto/frequenz/api/test/test.proto:// TODO(cookiecutter): Add a more descriptive package description.
./proto/frequenz/api/test/test.proto:// TODO(cookiecutter): Remove this message.
./py/frequenz/api/test/__init__.py:TODO(cookiecutter): Add a more descriptive module description.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
repo_name: "frequenz-api-test"
repo_url: "https://github.com/frequenz-floss/frequenz-api-test"
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
# if the project uses a different default branch.
edit_uri: "edit/main/docs/"
edit_uri: "edit/v0.x.x/docs/"
strict: true # Treat warnings as errors

# Build directories
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here
./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links
./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
repo_name: "frequenz-app-test"
repo_url: "https://github.com/frequenz-floss/frequenz-app-test"
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
# if the project uses a different default branch.
edit_uri: "edit/main/docs/"
edit_uri: "edit/v0.x.x/docs/"
strict: true # Treat warnings as errors

# Build directories
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here
./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links
./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
repo_name: "frequenz-test-python"
repo_url: "https://github.com/frequenz-floss/frequenz-test-python"
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
# if the project uses a different default branch.
edit_uri: "edit/main/docs/"
edit_uri: "edit/v0.x.x/docs/"
strict: true # Treat warnings as errors

# Build directories
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here
./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links
./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
repo_name: "frequenz-model-test"
repo_url: "https://github.com/frequenz-floss/frequenz-model-test"
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
# if the project uses a different default branch.
edit_uri: "edit/main/docs/"
edit_uri: "edit/v0.x.x/docs/"
strict: true # Treat warnings as errors

# Build directories
Expand Down

0 comments on commit c94107e

Please sign in to comment.