diff --git a/docs/config.yml b/docs/config.yml index 5c5fe208..d7ff0847 100644 --- a/docs/config.yml +++ b/docs/config.yml @@ -22,6 +22,7 @@ extra: translated: true # false hides content related to building translations. Default: false. hide_coverage: false # true hides content related to code coverage. Default: false. macos_only: false # true hides tabbed content, and displays only macOS instructions. Default: false. + contribution_guide_root: content_test_bed/how-to/contribute alternate: - name: English link: /en/ diff --git a/docs/en/content_test_bed/how-to/contribute/first-time-contributors.md b/docs/en/content_test_bed/how-to/contribute/first-time-contributors.md index 42600289..04a45720 100644 --- a/docs/en/content_test_bed/how-to/contribute/first-time-contributors.md +++ b/docs/en/content_test_bed/how-to/contribute/first-time-contributors.md @@ -1,3 +1,3 @@ # First-time contributors -{% extends "contribute/first-time-contributors.md" %} +{% extends "_shared/contribute/first-time-contributors.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/how/branches.md b/docs/en/content_test_bed/how-to/contribute/how/branches.md index f230e8ca..88d2da3c 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/branches.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/build-docs.md b/docs/en/content_test_bed/how-to/contribute/how/build-docs.md index 3c5f6f36..7755ef97 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/build-docs.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/change-note.md b/docs/en/content_test_bed/how-to/contribute/how/change-note.md index 236fac69..f499d90d 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/change-note.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/dev-environment.md b/docs/en/content_test_bed/how-to/contribute/how/dev-environment.md index fb52b53b..2f2e1067 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/dev-environment.md +++ b/docs/en/content_test_bed/how-to/contribute/how/dev-environment.md @@ -1,3 +1,3 @@ # Setting up a development environment -{% extends "contribute/how/dev-environment.md" %} +{% extends "_shared/contribute/how/dev-environment.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/how/new-issue.md b/docs/en/content_test_bed/how-to/contribute/how/new-issue.md index fceca0ed..30f3f0c0 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/new-issue.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/propose-feature.md b/docs/en/content_test_bed/how-to/contribute/how/propose-feature.md index 008b9d6f..cd274895 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/propose-feature.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/reproduce-issue.md b/docs/en/content_test_bed/how-to/contribute/how/reproduce-issue.md index 319dbb6a..e765196c 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/reproduce-issue.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/review-pr.md b/docs/en/content_test_bed/how-to/contribute/how/review-pr.md index 047a0b43..30e8d2fa 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/review-pr.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/scope-creep.md b/docs/en/content_test_bed/how-to/contribute/how/scope-creep.md index c2824279..22718a3f 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/scope-creep.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/submit-pr.md b/docs/en/content_test_bed/how-to/contribute/how/submit-pr.md index 6f92de86..5937a49d 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/submit-pr.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/translate.md b/docs/en/content_test_bed/how-to/contribute/how/translate.md index 9d40413b..1eea13cf 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/translate.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/write-code.md b/docs/en/content_test_bed/how-to/contribute/how/write-code.md index bd585753..a167a69c 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/write-code.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/how/write-docs.md b/docs/en/content_test_bed/how-to/contribute/how/write-docs.md index c3d86ec0..146b398a 100644 --- a/docs/en/content_test_bed/how-to/contribute/how/write-docs.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/index.md b/docs/en/content_test_bed/how-to/contribute/index.md index b14329fe..e828b1f1 100644 --- a/docs/en/content_test_bed/how-to/contribute/index.md +++ b/docs/en/content_test_bed/how-to/contribute/index.md @@ -1,3 +1,3 @@ # Contributing to {{ formal_name }} -{% extends "contribute/index.md" %} +{% extends "_shared/contribute/index.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/next/pr-review.md b/docs/en/content_test_bed/how-to/contribute/next/pr-review.md index f2a408fe..65cfdfc7 100644 --- a/docs/en/content_test_bed/how-to/contribute/next/pr-review.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/next/release.md b/docs/en/content_test_bed/how-to/contribute/next/release.md index 3f9995e3..44a7772c 100644 --- a/docs/en/content_test_bed/how-to/contribute/next/release.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/policies/ai-policy.md b/docs/en/content_test_bed/how-to/contribute/policies/ai-policy.md index e17e9998..3e9364b2 100644 --- a/docs/en/content_test_bed/how-to/contribute/policies/ai-policy.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/style/code-style-guide.md b/docs/en/content_test_bed/how-to/contribute/style/code-style-guide.md index bba1179b..43f8d1f7 100644 --- a/docs/en/content_test_bed/how-to/contribute/style/code-style-guide.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/style/docs-style-guide.md b/docs/en/content_test_bed/how-to/contribute/style/docs-style-guide.md index 1b0ea184..5164a0a1 100644 --- a/docs/en/content_test_bed/how-to/contribute/style/docs-style-guide.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/what/fix-issue.md b/docs/en/content_test_bed/how-to/contribute/what/fix-issue.md index d30549e8..8cdb8bf1 100644 --- a/docs/en/content_test_bed/how-to/contribute/what/fix-issue.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/what/implement-feature.md b/docs/en/content_test_bed/how-to/contribute/what/implement-feature.md index 4af9f120..c1ecd287 100644 --- a/docs/en/content_test_bed/how-to/contribute/what/implement-feature.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/what/propose-feature.md b/docs/en/content_test_bed/how-to/contribute/what/propose-feature.md index 3b2b1eaf..c8152055 100644 --- a/docs/en/content_test_bed/how-to/contribute/what/propose-feature.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/what/review-pr.md b/docs/en/content_test_bed/how-to/contribute/what/review-pr.md index aa2fe0ab..9c4b9f80 100644 --- a/docs/en/content_test_bed/how-to/contribute/what/review-pr.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/what/translate.md b/docs/en/content_test_bed/how-to/contribute/what/translate.md index 9d4a07d9..c015732f 100644 --- a/docs/en/content_test_bed/how-to/contribute/what/translate.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/what/triage.md b/docs/en/content_test_bed/how-to/contribute/what/triage.md index ec4bc414..ead5509d 100644 --- a/docs/en/content_test_bed/how-to/contribute/what/triage.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/what/use-tools.md b/docs/en/content_test_bed/how-to/contribute/what/use-tools.md index 83155a3b..cc775326 100644 --- a/docs/en/content_test_bed/how-to/contribute/what/use-tools.md +++ b/docs/en/content_test_bed/how-to/contribute/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/content_test_bed/how-to/contribute/what/write-docs.md b/docs/en/content_test_bed/how-to/contribute/what/write-docs.md index b1a973fb..3be56fed 100644 --- a/docs/en/content_test_bed/how-to/contribute/what/write-docs.md +++ b/docs/en/content_test_bed/how-to/contribute/what/write-docs.md @@ -1,3 +1,3 @@ # Adding documentation -{% extends "contribute/what/write-docs.md" %} +{% extends "_shared/contribute/what/write-docs.md" %} diff --git a/pyproject.toml b/pyproject.toml index 7d5d6a1a..2b697c5f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,13 +23,13 @@ maintainers = [ ] dependencies = [ - "click==8.3.3", + "click==8.4.0", "deepl==1.30.0", "markdown-checker==1.0.3", "mistletoe==1.5.1", "mkdocs-autorefs==1.4.4", "mkdocs-literate-nav==0.6.3", # DO NOT UPGRADE - Uncertain whether author's move to ProperDocs will cause incompatibility - "mkdocs-macros-plugin==1.5.0", + "mkdocs-macros-plugin @ git+https://github.com/kattni/mkdocs-macros-plugin@include-dir-multiple-directories", "mkdocs-material==9.7.6", "mkdocs-rss-plugin==1.19.0", "mkdocs==1.6.1", # DO NOT UPGRADE - 2+ is not compatible with anything here diff --git a/src/beeware_docs_tools/live_serve_en.py b/src/beeware_docs_tools/live_serve_en.py index f7c0cbc5..a99d4712 100644 --- a/src/beeware_docs_tools/live_serve_en.py +++ b/src/beeware_docs_tools/live_serve_en.py @@ -66,7 +66,6 @@ def serve_docs( "mkdocs", "serve", "--clean", - "--livereload", "--config-file", str(output_path / "mkdocs.en.yml"), "--watch", diff --git a/src/beeware_docs_tools/md_tempdir.py b/src/beeware_docs_tools/md_tempdir.py index f5d38da1..e81090b1 100644 --- a/src/beeware_docs_tools/md_tempdir.py +++ b/src/beeware_docs_tools/md_tempdir.py @@ -68,14 +68,23 @@ def save_config(project_path, temp_md_path, config, language="en"): base_path = config["markdown_extensions"]["pymdownx.snippets"].get("base_path", []) + contribution_root = config["extra"].get( + "contribution_guide_root", "how-to/contribute" + ) + if language != "en": shared_content_path = temp_md_path.resolve() / f"shared_content/{language}" + local_docs_path = temp_md_path.resolve() / language / contribution_root else: shared_content_path = (Path(__file__).parent / "shared_content/en").resolve() + local_docs_path = (project_path / "docs/en" / contribution_root).resolve() base_path.append(str(shared_content_path)) config["markdown_extensions"]["pymdownx.snippets"]["base_path"] = base_path - config["plugins"]["macros"]["include_dir"] = str(shared_content_path) + config["plugins"]["macros"]["include_dir"] = [ + str(shared_content_path), + str(local_docs_path), + ] with (temp_md_path / "config.yml").open("w", encoding="utf-8") as config_f: yaml.dump(config, config_f) diff --git a/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css b/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css index 6687c045..ee62aa0d 100644 --- a/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css +++ b/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css @@ -653,3 +653,8 @@ footer.md-footer *, html .md-footer-meta.md-typeset a { .md-typeset table:not([class]) { font-size: 1rem; } + +/* Remove H1 from collapsed content */ +details.abstract h1 { + display: none; +} diff --git a/src/beeware_docs_tools/shared_content/en/contribute/first-time-contributors.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/first-time-contributors.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/first-time-contributors.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/first-time-contributors.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/branches.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/branches.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/branches.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/branches.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/build-docs.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/build-docs.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/build-docs.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/build-docs.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/change-note.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/change-note.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/change-note.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/change-note.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/dev-environment.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/dev-environment.md similarity index 94% rename from src/beeware_docs_tools/shared_content/en/contribute/how/dev-environment.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/dev-environment.md index 814b0ac2..1aa95507 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/how/dev-environment.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/dev-environment.md @@ -1,14 +1,3 @@ - -{% if config.extra.website %} - -Contributing to BeeWare requires you to pick a project and set up a development environment: - -* [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/) - -{% else %} - Contributing to {{ formal_name }} requires you to set up a development environment. ### Prerequisites { #dev-environment-prereqs } @@ -315,6 +304,4 @@ pre-commit installed at .git/hooks/pre-commit {% endif %} -{% endif %} - Now you are ready to start hacking on {{ formal_name }}! diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/new-issue.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/new-issue.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/new-issue.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/new-issue.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/propose-feature.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/propose-feature.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/propose-feature.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/propose-feature.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/reproduce-issue.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/reproduce-issue.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/reproduce-issue.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/reproduce-issue.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/review-pr.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/review-pr.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/scope-creep.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/scope-creep.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/scope-creep.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/scope-creep.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/submit-pr.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/submit-pr.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/submit-pr.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/submit-pr.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/translate.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/translate.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/translate.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/translate.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/write-code.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/write-code.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/write-code.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/write-code.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/write-docs.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/write-docs.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/write-docs.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/write-docs.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/index.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/index.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/index.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/index.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/next/pr-review.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/next/pr-review.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/next/pr-review.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/next/pr-review.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/next/release.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/next/release.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/next/release.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/next/release.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/policies/ai-policy.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/policies/ai-policy.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/policies/ai-policy.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/policies/ai-policy.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/style/code-style-guide.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/style/code-style-guide.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/style/code-style-guide.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/style/code-style-guide.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/style/docs-style-guide.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/style/docs-style-guide.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/style/docs-style-guide.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/style/docs-style-guide.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/fix-issue.md similarity index 88% rename from src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/fix-issue.md index f76afb66..ced4c1d5 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/fix-issue.md @@ -12,19 +12,19 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Set up a development environment -{% include "contribute/how/dev-environment.md" %} +{% include "how/dev-environment.md" %} /// /// details-abstract | Work from a branch -{% include "contribute/how/branches.md" %} +{% include "how/branches.md" %} /// /// details-abstract | Reproduce the issue -{% include "contribute/how/reproduce-issue.md" %} +{% include "how/reproduce-issue.md" %} /// @@ -32,7 +32,7 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Write, run, and test code -{% include "contribute/how/write-code.md" %} +{% include "how/write-code.md" %} /// @@ -40,13 +40,13 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Build documentation -{% include "contribute/how/build-docs.md" %} +{% include "how/build-docs.md" %} /// /// details-abstract | Write documentation -{% include "contribute/how/write-docs.md" %} +{% include "how/write-docs.md" %} /// @@ -54,12 +54,12 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Add a change note -{% include "contribute/how/change-note.md" %} +{% include "how/change-note.md" %} /// /// details-abstract | Submit a pull request -{% include "contribute/how/submit-pr.md" %} +{% include "how/submit-pr.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/implement-feature.md similarity index 81% rename from src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/implement-feature.md index c8035690..b2f6c002 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/implement-feature.md @@ -15,48 +15,48 @@ An important part of implementing a new feature is ensuring that feature is full /// details-abstract | Set up a development environment -{% include "contribute/how/dev-environment.md" %} +{% include "how/dev-environment.md" %} /// /// details-abstract | Work from a branch -{% include "contribute/how/branches.md" %} +{% include "how/branches.md" %} /// /// details-abstract | Avoid scope creep -{% include "contribute/how/scope-creep.md" %} +{% include "how/scope-creep.md" %} /// /// details-abstract | Implement the new feature -{% include "contribute/how/write-code.md" %} +{% include "how/write-code.md" %} /// /// details-abstract | Build documentation -{% include "contribute/how/build-docs.md" %} +{% include "how/build-docs.md" %} /// /// details-abstract | Write documentation -{% include "contribute/how/write-docs.md" %} +{% include "how/write-docs.md" %} /// /// details-abstract | Add a change note -{% include "contribute/how/change-note.md" %} +{% include "how/change-note.md" %} /// /// details-abstract | Submit a pull request -{% include "contribute/how/submit-pr.md" %} +{% include "how/submit-pr.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/propose-feature.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/propose-feature.md similarity index 98% rename from src/beeware_docs_tools/shared_content/en/contribute/what/propose-feature.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/propose-feature.md index 957d1831..6d7952dd 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/propose-feature.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/propose-feature.md @@ -38,6 +38,6 @@ If you're unsure about any of this, don't worry! Submit your idea, and let us kn /// details-abstract | Proposing a new feature -{% include "contribute/how/propose-feature.md" %} +{% include "how/propose-feature.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/review-pr.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md similarity index 97% rename from src/beeware_docs_tools/shared_content/en/contribute/what/review-pr.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md index 0bd7aa4e..fe826a80 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/review-pr.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md @@ -16,6 +16,6 @@ As a first-time contributor, you should feel free to review any pull request you /// details-abstract | Providing a pull request review -{% include "contribute/how/review-pr.md" %} +{% include "how/review-pr.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/translate.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/translate.md similarity index 95% rename from src/beeware_docs_tools/shared_content/en/contribute/what/translate.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/translate.md index 13da095c..7781a91e 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/translate.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/translate.md @@ -10,6 +10,6 @@ We use [DeepL](https://www.deepl.com/en/translator) for machine translation to p /// details-abstract | Translate content -{% include "contribute/how/translate.md" %} +{% include "how/translate.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/triage.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/triage.md similarity index 95% rename from src/beeware_docs_tools/shared_content/en/contribute/what/triage.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/triage.md index ae63fbf6..b21e1338 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/triage.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/triage.md @@ -8,6 +8,6 @@ Triaging an issue does not mean you are expected to fix it. Depending on the iss /// details-abstract | Reproduce the issue -{% include "contribute/how/reproduce-issue.md" %} +{% include "how/reproduce-issue.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/use-tools.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/use-tools.md similarity index 91% rename from src/beeware_docs_tools/shared_content/en/contribute/what/use-tools.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/use-tools.md index 8db5c9d4..86dd6b38 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/use-tools.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/use-tools.md @@ -10,12 +10,12 @@ If you do experience any problems, start a new discussion topic, as it may be th /// details-abstract | Submit a new issue -{% include "contribute/how/new-issue.md" %} +{% include "how/new-issue.md" %} /// /// details-abstract | Propose a new feature -{% include "contribute/how/propose-feature.md" %} +{% include "how/propose-feature.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/write-docs.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/write-docs.md similarity index 94% rename from src/beeware_docs_tools/shared_content/en/contribute/what/write-docs.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/write-docs.md index d78c0b96..7db47ed0 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/write-docs.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/write-docs.md @@ -49,48 +49,48 @@ A reference guide in baking might describe the types of sugar that could be used /// details-abstract | Proposing new documentation -{% include "contribute/how/propose-feature.md" %} +{% include "how/propose-feature.md" %} /// /// details-abstract | Set up a development environment -{% include "contribute/how/dev-environment.md" %} +{% include "how/dev-environment.md" %} /// /// details-abstract | Work from a branch -{% include "contribute/how/branches.md" %} +{% include "how/branches.md" %} /// /// details-abstract | Avoid scope creep -{% include "contribute/how/scope-creep.md" %} +{% include "how/scope-creep.md" %} /// /// details-abstract | Building documentation -{% include "contribute/how/build-docs.md" %} +{% include "how/build-docs.md" %} /// /// details-abstract | Writing documentation -{% include "contribute/how/write-docs.md" %} +{% include "how/write-docs.md" %} /// /// details-abstract | Add a change note -{% include "contribute/how/change-note.md" %} +{% include "how/change-note.md" %} /// /// details-abstract | Submit a pull request -{% include "contribute/how/submit-pr.md" %} +{% include "how/submit-pr.md" %} ///