-
-
Notifications
You must be signed in to change notification settings - Fork 812
Updates to match docs-tools changes. #789
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # First-time contributors { #first-time-contributors } | ||
|
|
||
| {% extends "contribute/first-time-contributors.md" %} | ||
| {% extends "_shared/contribute/first-time-contributors.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Work from a feature branch, not your `main` branch | ||
|
|
||
| {% extends "contribute/how/branches.md" %} | ||
| {% extends "_shared/contribute/how/branches.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Adding change information for release notes | ||
|
|
||
| {% extends "contribute/how/change-note.md" %} | ||
| {% extends "_shared/contribute/how/change-note.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Submitting a new issue | ||
|
|
||
| {% extends "contribute/how/new-issue.md" %} | ||
| {% extends "_shared/contribute/how/new-issue.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Providing a pull request review | ||
|
|
||
| {% extends "contribute/how/review-pr.md" %} | ||
| {% extends "_shared/contribute/how/review-pr.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Avoiding scope creep | ||
|
|
||
| {% extends "contribute/how/scope-creep.md" %} | ||
| {% extends "_shared/contribute/how/scope-creep.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Translating content | ||
|
|
||
| {% extends "contribute/how/translate.md" %} | ||
| {% extends "_shared/contribute/how/translate.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Contribution guide | ||
|
|
||
| {% extends "contribute/index.md" %} | ||
| {% extends "_shared/contribute/index.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Receiving a pull request review | ||
|
|
||
| {% extends "contribute/next/pr-review.md" %} | ||
| {% extends "_shared/contribute/next/pr-review.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # The release process | ||
|
|
||
| {% extends "contribute/next/release.md" %} | ||
| {% extends "_shared/contribute/next/release.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| <!-- rumdl-disable-file MD041 --> | ||
|
|
||
| {% extends "contribute/policies/ai-policy.md" %} | ||
| {% extends "_shared/contribute/policies/ai-policy.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Code style guide | ||
|
|
||
| {% extends "contribute/style/code-style-guide.md" %} | ||
| {% extends "_shared/contribute/style/code-style-guide.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Documentation style guide | ||
|
|
||
| {% extends "contribute/style/docs-style-guide.md" %} | ||
| {% extends "_shared/contribute/style/docs-style-guide.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Fixing an issue | ||
|
|
||
| {% extends "contribute/what/fix-issue.md" %} | ||
| {% extends "_shared/contribute/what/fix-issue.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Implementing a new feature | ||
|
|
||
| {% extends "contribute/what/implement-feature.md" %} | ||
| {% extends "_shared/contribute/what/implement-feature.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Proposing a new feature | ||
|
|
||
| {% extends "contribute/what/propose-feature.md" %} | ||
| {% extends "_shared/contribute/what/propose-feature.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Providing a pull request review | ||
|
|
||
| {% extends "contribute/what/review-pr.md" %} | ||
| {% extends "_shared/contribute/what/review-pr.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Translating content | ||
|
|
||
| {% extends "contribute/what/translate.md" %} | ||
| {% extends "_shared/contribute/what/translate.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Triaging an issue | ||
|
|
||
| {% extends "contribute/what/triage.md" %} | ||
| {% extends "_shared/contribute/what/triage.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Using the tools | ||
|
|
||
| {% extends "contribute/what/use-tools.md" %} | ||
| {% extends "_shared/contribute/what/use-tools.md" %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Adding documentation | ||
|
|
||
| {% extends "contribute/what/write-docs.md" %} | ||
| {% extends "_shared/contribute/what/write-docs.md" %} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.