-
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Add notes about contributing documentation content (#86)
* chore: Add notes about contributing documentation content * chore: Add CODEOWNERS file
- Loading branch information
Showing
4 changed files
with
30 additions
and
13 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
* @gchtr @Levdbas | ||
*.yml @Levdbas @nlemoine |
This file contains 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,26 +1,30 @@ | ||
<!-- | ||
First off, hello! | ||
IMPORTANT! | ||
Thanks for submitting a PR. We love/welcome PRs (especially if it’s your first). | ||
If you want to contribute content to the documentation, you should create a pull request in the timber/timber repository (https://github.com/timber/timber/). The documentation content lives in the **/docs/** folder of the Timber repository. | ||
Do you have updates for the content of the documentation (typos, grammar, spelling)? Please open a new issue in the timber/timber repository: https://github.com/timber/timber/issues/new/choose. | ||
--> | ||
This repository (timber/docs) is only used to build the documentation site. It pulls the documentation content from the Timber repository. | ||
--> | ||
|
||
<!-- Remove this if no related tickets exist. --> | ||
<!-- You can add the related ticket numbers here using #. Example: #2471 --> | ||
Related: | ||
|
||
- Ticket 1 | ||
- Ticket 2 | ||
|
||
## Issue | ||
<!-- Description of the problem that this code change is solving --> | ||
|
||
|
||
## Solution | ||
<!-- Description of the solution that this code changes are introducing to the application. --> | ||
|
||
|
||
## Impact | ||
<!-- What impact will this have on the current codebase, performance, backwards compatibility? --> | ||
|
||
|
||
## Usage Changes | ||
<!-- Are there are any usage changes that we need to know about? --> | ||
|
||
<!-- Are there are any usage changes that we need to know about? If so, list them here so that we can integrate it in the release notes and developers know what usage changes are associated to your PR. | ||
--> | ||
|
||
## Considerations | ||
<!-- As we do not live in an ideal world it’s worth to share your thought on how we could make the solution even better. --> | ||
<!-- As we do not live in an ideal world it's worth to share your thought on how we could make the solution even better. --> |
This file contains 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 |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Contributing to Timber Documentation | ||
|
||
Please refer to the [README.md](https://github.com/timber/docs/blob/master/README.md) for how to contribute to timber/docs. | ||
|
||
> [!IMPORTANT] | ||
> If you want to **contribute content** to the documentation, you should create a pull request in the [timber/timber repository](https://github.com/timber/timber/). The documentation content lives in the **/docs/** folder of the Timber repository. | ||
> | ||
> This repository (timber/docs) is only used to build the documentation site. It pulls the documentation content from the Timber repository. |
This file contains 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