diff --git a/docs/config.yml b/docs/config.yml index 6ea75e0543..c63bcc8ba4 100644 --- a/docs/config.yml +++ b/docs/config.yml @@ -79,6 +79,7 @@ extra: min_python_version_tag: "310" # The tag version of the minimum python version recent_python_version: "3.13" # The newest Python version known to work on all platforms docs_python_version: "3.13" # The version of Python required to build the documentation + contribution_guide_root: contributing/guide/ social: - icon: fontawesome/brands/github link: https://github.com/beeware diff --git a/docs/en/contributing/first-time-contributors.md b/docs/en/contributing/first-time-contributors.md index 2760785367..080c342a77 100644 --- a/docs/en/contributing/first-time-contributors.md +++ b/docs/en/contributing/first-time-contributors.md @@ -1,3 +1,3 @@ # First-time contributors { #first-time-contributors } -{% extends "contribute/first-time-contributors.md" %} +{% extends "_shared/contribute/first-time-contributors.md" %} diff --git a/docs/en/contributing/guide/how/branches.md b/docs/en/contributing/guide/how/branches.md index f230e8ca05..88d2da3ce8 100644 --- a/docs/en/contributing/guide/how/branches.md +++ b/docs/en/contributing/guide/how/branches.md @@ -1,3 +1,3 @@ # Work from a feature branch, not your `main` branch -{% extends "contribute/how/branches.md" %} +{% extends "_shared/contribute/how/branches.md" %} diff --git a/docs/en/contributing/guide/how/build-docs.md b/docs/en/contributing/guide/how/build-docs.md index 3c5f6f36b1..7755ef9798 100644 --- a/docs/en/contributing/guide/how/build-docs.md +++ b/docs/en/contributing/guide/how/build-docs.md @@ -1,15 +1,15 @@ # Building documentation -{% extends "contribute/how/build-docs.md" %} +{% extends "_shared/contribute/how/build-docs.md" %} {% block front_matter %} -Before you build the documentation, and have a [development environment](dev-environment.md) set up. +Before you build the documentation, and have a [development environment](../how/dev-environment.md) set up. {% endblock %} {% block end_matter %} -Once you have successfully built the docs, you are ready to [write documentation](write-docs.md). +Once you have successfully built the docs, you are ready to [write documentation](../how/write-docs.md). {% endblock %} diff --git a/docs/en/contributing/guide/how/change-note.md b/docs/en/contributing/guide/how/change-note.md index 236fac6990..f499d90d64 100644 --- a/docs/en/contributing/guide/how/change-note.md +++ b/docs/en/contributing/guide/how/change-note.md @@ -1,3 +1,3 @@ # Adding change information for release notes -{% extends "contribute/how/change-note.md" %} +{% extends "_shared/contribute/how/change-note.md" %} diff --git a/docs/en/contributing/guide/how/dev-environment.md b/docs/en/contributing/guide/how/dev-environment.md index fb52b53ba6..dbeb475eed 100644 --- a/docs/en/contributing/guide/how/dev-environment.md +++ b/docs/en/contributing/guide/how/dev-environment.md @@ -1,3 +1,9 @@ # Setting up a development environment -{% extends "contribute/how/dev-environment.md" %} +The steps for setting up a development environment vary depending on the project you're contributing to. Choose from the following: + +* [Briefcase](https://briefcase.beeware.org/en/stable/how-to/contribute/how/dev-environment/) +* [Toga](https://toga.beeware.org/en/stable/how-to/contribute/how/dev-environment/) +* [Rubicon Objective-C](https://rubicon-objc.beeware.org/en/stable/how-to/contribute/how/dev-environment/) + +If the repository you want to contribute to isn't on this list, follow the development guide for the most relevant project. For example, if you want to work on a Briefcase template repository, you should follow the guide for Briefcase. diff --git a/docs/en/contributing/guide/how/new-issue.md b/docs/en/contributing/guide/how/new-issue.md index fceca0ed53..30f3f0c0ba 100644 --- a/docs/en/contributing/guide/how/new-issue.md +++ b/docs/en/contributing/guide/how/new-issue.md @@ -1,3 +1,3 @@ # Submitting a new issue -{% extends "contribute/how/new-issue.md" %} +{% extends "_shared/contribute/how/new-issue.md" %} diff --git a/docs/en/contributing/guide/how/propose-feature.md b/docs/en/contributing/guide/how/propose-feature.md index 008b9d6f7c..cd274895ee 100644 --- a/docs/en/contributing/guide/how/propose-feature.md +++ b/docs/en/contributing/guide/how/propose-feature.md @@ -1,6 +1,6 @@ # Proposing a new feature -{% extends "contribute/how/propose-feature.md" %} +{% extends "_shared/contribute/how/propose-feature.md" %} {% block end_matter %} diff --git a/docs/en/contributing/guide/how/reproduce-issue.md b/docs/en/contributing/guide/how/reproduce-issue.md index 319dbb6a29..e765196c8b 100644 --- a/docs/en/contributing/guide/how/reproduce-issue.md +++ b/docs/en/contributing/guide/how/reproduce-issue.md @@ -1,10 +1,10 @@ # Reproducing an issue -{% extends "contribute/how/reproduce-issue.md" %} +{% extends "_shared/contribute/how/reproduce-issue.md" %} {% block front_matter %} -To begin reproducing an issue, you will need a [development environment](dev-environment.md) set up. +To begin reproducing an issue, you will need a [development environment](../how/dev-environment.md) set up. {% endblock %} diff --git a/docs/en/contributing/guide/how/review-pr.md b/docs/en/contributing/guide/how/review-pr.md index 047a0b4356..30e8d2faf6 100644 --- a/docs/en/contributing/guide/how/review-pr.md +++ b/docs/en/contributing/guide/how/review-pr.md @@ -1,3 +1,3 @@ # Providing a pull request review -{% extends "contribute/how/review-pr.md" %} +{% extends "_shared/contribute/how/review-pr.md" %} diff --git a/docs/en/contributing/guide/how/scope-creep.md b/docs/en/contributing/guide/how/scope-creep.md index c2824279c3..22718a3f36 100644 --- a/docs/en/contributing/guide/how/scope-creep.md +++ b/docs/en/contributing/guide/how/scope-creep.md @@ -1,3 +1,3 @@ # Avoiding scope creep -{% extends "contribute/how/scope-creep.md" %} +{% extends "_shared/contribute/how/scope-creep.md" %} diff --git a/docs/en/contributing/guide/how/submit-pr.md b/docs/en/contributing/guide/how/submit-pr.md index 6f92de866b..5937a49d05 100644 --- a/docs/en/contributing/guide/how/submit-pr.md +++ b/docs/en/contributing/guide/how/submit-pr.md @@ -1,16 +1,16 @@ # Submitting a pull request -{% extends "contribute/how/submit-pr.md" %} +{% extends "_shared/contribute/how/submit-pr.md" %} {% block end_matter %} {% if config.extra.website %} -Your pull request may require additional content, such as a [change note](change-note.md), before it can be [reviewed](../next/pr-review.md). +Your pull request may require additional content, such as a [change note](../how/change-note.md), before it can be [reviewed](../next/pr-review.md). {% else %} -As part of submitting a pull request, you'll need to include a [change note](change-note.md) before it can be [reviewed](../next/pr-review.md). +As part of submitting a pull request, you'll need to include a [change note](../how/change-note.md) before it can be [reviewed](../next/pr-review.md). {% endif %} diff --git a/docs/en/contributing/guide/how/translate.md b/docs/en/contributing/guide/how/translate.md index 9d40413bfa..1eea13cfaa 100644 --- a/docs/en/contributing/guide/how/translate.md +++ b/docs/en/contributing/guide/how/translate.md @@ -1,3 +1,3 @@ # Translating content -{% extends "contribute/how/translate.md" %} +{% extends "_shared/contribute/how/translate.md" %} diff --git a/docs/en/contributing/guide/how/write-code.md b/docs/en/contributing/guide/how/write-code.md index bd58575317..a167a69c81 100644 --- a/docs/en/contributing/guide/how/write-code.md +++ b/docs/en/contributing/guide/how/write-code.md @@ -1,15 +1,15 @@ # Writing, running, and testing code -{% extends "contribute/how/write-code.md" %} +{% extends "_shared/contribute/how/write-code.md" %} {% block front_matter %} -To begin working on code, ensure you have a [development environment](dev-environment.md) set up, and you are [working on a branch](branches.md) +To begin working on code, ensure you have a [development environment](../how/dev-environment.md) set up, and you are [working on a branch](../how/branches.md) {% endblock %} {% block end_matter %} -Once you have everything working, you can [submit a pull request](submit-pr.md) with your changes. +Once you have everything working, you can [submit a pull request](../how/submit-pr.md) with your changes. {% endblock %} diff --git a/docs/en/contributing/guide/how/write-docs.md b/docs/en/contributing/guide/how/write-docs.md index c3d86ec001..146b398ab7 100644 --- a/docs/en/contributing/guide/how/write-docs.md +++ b/docs/en/contributing/guide/how/write-docs.md @@ -1,15 +1,15 @@ # Writing documentation -{% extends "contribute/how/write-docs.md" %} +{% extends "_shared/contribute/how/write-docs.md" %} {% block front_matter %} -Before you begin writing documentation, ensure you are able to [build the documentation](build-docs.md), and you are [working on a branch](branches.md). +Before you begin writing documentation, ensure you are able to [build the documentation](../how/build-docs.md), and you are [working on a branch](../how/branches.md). {% endblock %} {% block end_matter %} -Once you are happy with your new documentation, you can [submit a pull request](submit-pr.md) with your proposed changes. +Once you are happy with your new documentation, you can [submit a pull request](../how/submit-pr.md) with your proposed changes. {% endblock %} diff --git a/docs/en/contributing/guide/index.md b/docs/en/contributing/guide/index.md index 8afd875623..0443b03362 100644 --- a/docs/en/contributing/guide/index.md +++ b/docs/en/contributing/guide/index.md @@ -1,3 +1,3 @@ # Contribution guide -{% extends "contribute/index.md" %} +{% extends "_shared/contribute/index.md" %} diff --git a/docs/en/contributing/guide/next/pr-review.md b/docs/en/contributing/guide/next/pr-review.md index f2a408fece..65cfdfc7e0 100644 --- a/docs/en/contributing/guide/next/pr-review.md +++ b/docs/en/contributing/guide/next/pr-review.md @@ -1,3 +1,3 @@ # Receiving a pull request review -{% extends "contribute/next/pr-review.md" %} +{% extends "_shared/contribute/next/pr-review.md" %} diff --git a/docs/en/contributing/guide/next/release.md b/docs/en/contributing/guide/next/release.md index 3f9995e3b5..44a7772c7d 100644 --- a/docs/en/contributing/guide/next/release.md +++ b/docs/en/contributing/guide/next/release.md @@ -1,3 +1,3 @@ # The release process -{% extends "contribute/next/release.md" %} +{% extends "_shared/contribute/next/release.md" %} diff --git a/docs/en/contributing/guide/policies/ai-policy.md b/docs/en/contributing/guide/policies/ai-policy.md index e17e99981e..3e9364b251 100644 --- a/docs/en/contributing/guide/policies/ai-policy.md +++ b/docs/en/contributing/guide/policies/ai-policy.md @@ -1,3 +1,3 @@ -{% extends "contribute/policies/ai-policy.md" %} +{% extends "_shared/contribute/policies/ai-policy.md" %} diff --git a/docs/en/contributing/guide/style/code-style-guide.md b/docs/en/contributing/guide/style/code-style-guide.md index bba1179b2d..43f8d1f70a 100644 --- a/docs/en/contributing/guide/style/code-style-guide.md +++ b/docs/en/contributing/guide/style/code-style-guide.md @@ -1,3 +1,3 @@ # Code style guide -{% extends "contribute/style/code-style-guide.md" %} +{% extends "_shared/contribute/style/code-style-guide.md" %} diff --git a/docs/en/contributing/guide/style/docs-style-guide.md b/docs/en/contributing/guide/style/docs-style-guide.md index 1b0ea184aa..5164a0a1d2 100644 --- a/docs/en/contributing/guide/style/docs-style-guide.md +++ b/docs/en/contributing/guide/style/docs-style-guide.md @@ -1,3 +1,3 @@ # Documentation style guide -{% extends "contribute/style/docs-style-guide.md" %} +{% extends "_shared/contribute/style/docs-style-guide.md" %} diff --git a/docs/en/contributing/guide/what/fix-issue.md b/docs/en/contributing/guide/what/fix-issue.md index d30549e837..8cdb8bf1de 100644 --- a/docs/en/contributing/guide/what/fix-issue.md +++ b/docs/en/contributing/guide/what/fix-issue.md @@ -1,3 +1,3 @@ # Fixing an issue -{% extends "contribute/what/fix-issue.md" %} +{% extends "_shared/contribute/what/fix-issue.md" %} diff --git a/docs/en/contributing/guide/what/implement-feature.md b/docs/en/contributing/guide/what/implement-feature.md index 4af9f120ae..c1ecd287d1 100644 --- a/docs/en/contributing/guide/what/implement-feature.md +++ b/docs/en/contributing/guide/what/implement-feature.md @@ -1,3 +1,3 @@ # Implementing a new feature -{% extends "contribute/what/implement-feature.md" %} +{% extends "_shared/contribute/what/implement-feature.md" %} diff --git a/docs/en/contributing/guide/what/propose-feature.md b/docs/en/contributing/guide/what/propose-feature.md index 3b2b1eaf5d..c815205597 100644 --- a/docs/en/contributing/guide/what/propose-feature.md +++ b/docs/en/contributing/guide/what/propose-feature.md @@ -1,3 +1,3 @@ # Proposing a new feature -{% extends "contribute/what/propose-feature.md" %} +{% extends "_shared/contribute/what/propose-feature.md" %} diff --git a/docs/en/contributing/guide/what/review-pr.md b/docs/en/contributing/guide/what/review-pr.md index aa2fe0abe0..9c4b9f800c 100644 --- a/docs/en/contributing/guide/what/review-pr.md +++ b/docs/en/contributing/guide/what/review-pr.md @@ -1,3 +1,3 @@ # Providing a pull request review -{% extends "contribute/what/review-pr.md" %} +{% extends "_shared/contribute/what/review-pr.md" %} diff --git a/docs/en/contributing/guide/what/translate.md b/docs/en/contributing/guide/what/translate.md index 9d4a07d938..c015732f4d 100644 --- a/docs/en/contributing/guide/what/translate.md +++ b/docs/en/contributing/guide/what/translate.md @@ -1,3 +1,3 @@ # Translating content -{% extends "contribute/what/translate.md" %} +{% extends "_shared/contribute/what/translate.md" %} diff --git a/docs/en/contributing/guide/what/triage.md b/docs/en/contributing/guide/what/triage.md index ec4bc41496..ead5509d0c 100644 --- a/docs/en/contributing/guide/what/triage.md +++ b/docs/en/contributing/guide/what/triage.md @@ -1,3 +1,3 @@ # Triaging an issue -{% extends "contribute/what/triage.md" %} +{% extends "_shared/contribute/what/triage.md" %} diff --git a/docs/en/contributing/guide/what/use-tools.md b/docs/en/contributing/guide/what/use-tools.md index 83155a3b20..cc77532673 100644 --- a/docs/en/contributing/guide/what/use-tools.md +++ b/docs/en/contributing/guide/what/use-tools.md @@ -1,3 +1,3 @@ # Using the tools -{% extends "contribute/what/use-tools.md" %} +{% extends "_shared/contribute/what/use-tools.md" %} diff --git a/docs/en/contributing/guide/what/write-docs.md b/docs/en/contributing/guide/what/write-docs.md index b1a973fb65..3be56fede1 100644 --- a/docs/en/contributing/guide/what/write-docs.md +++ b/docs/en/contributing/guide/what/write-docs.md @@ -1,3 +1,3 @@ # Adding documentation -{% extends "contribute/what/write-docs.md" %} +{% extends "_shared/contribute/what/write-docs.md" %}