Skip to content

Commit 1bfaf5b

Browse files
authored
chore: Add notes about contributing documentation content (#86)
* chore: Add notes about contributing documentation content * chore: Add CODEOWNERS file
1 parent 7612177 commit 1bfaf5b

File tree

4 files changed

+30
-13
lines changed

4 files changed

+30
-13
lines changed

.github/CODEOWNERS

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* @gchtr @Levdbas
2+
*.yml @Levdbas @nlemoine

.github/pull_request_template.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,30 @@
11
<!--
2-
First off, hello!
2+
IMPORTANT!
33
4-
Thanks for submitting a PR. We love/welcome PRs (especially if it’s your first).
4+
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.
55
6-
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.
7-
-->
6+
This repository (timber/docs) is only used to build the documentation site. It pulls the documentation content from the Timber repository.
7+
-->
8+
9+
<!-- Remove this if no related tickets exist. -->
10+
<!-- You can add the related ticket numbers here using #. Example: #2471 -->
11+
Related:
12+
13+
- Ticket 1
14+
- Ticket 2
815

916
## Issue
1017
<!-- Description of the problem that this code change is solving -->
1118

12-
1319
## Solution
1420
<!-- Description of the solution that this code changes are introducing to the application. -->
1521

16-
1722
## Impact
1823
<!-- What impact will this have on the current codebase, performance, backwards compatibility? -->
1924

20-
2125
## Usage Changes
22-
<!-- Are there are any usage changes that we need to know about? -->
23-
26+
<!-- 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.
27+
-->
2428

2529
## Considerations
26-
<!-- As we do not live in an ideal world its worth to share your thought on how we could make the solution even better. -->
30+
<!-- 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. -->

CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributing to Timber Documentation
2+
3+
Please refer to the [README.md](https://github.com/timber/docs/blob/master/README.md) for how to contribute to timber/docs.
4+
5+
> [!IMPORTANT]
6+
> 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.
7+
>
8+
> This repository (timber/docs) is only used to build the documentation site. It pulls the documentation content from the Timber repository.

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This repository is used to build the documentation pages for [Timber](http://github.com/timber/timber). The documentation is generated using the static site generator [Eleventy](https://www.11ty.io/).
44

5+
> [!IMPORTANT]
6+
> 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.
7+
>
8+
> This repository (timber/docs) is only used to build the documentation site. It pulls the documentation content from the Timber repository.
9+
510
<!-- TOC -->
611

712
- [Overview](#overview)
@@ -27,8 +32,6 @@ The documentation consists of:
2732
- **Content pages** imported from the [`docs`](https://github.com/timber/timber/tree/master/docs/) folder of the Timber repository.
2833
- **Reference pages** for Timber’s PHP classes, which is generated directly from the inline DocBlock documentation of the PHP class files. This is handled by the **generate-docs.sh** file, which uses [Teak](https://github.com/timber/teak) to generate the reference.
2934

30-
If you want to **contribute content** to the documentation, you can create a pull request in the [Timber repository](https://github.com/timber/timber/).
31-
3235
## Writing docs
3336

3437
Each page for the documentation needs to be written in Markdown. Each page needs some meta data so that it will be linked in the right location in the docs. This is called [*Front Matter*](https://www.11ty.io/docs/data-frontmatter/) and comes in YAML style.
@@ -148,4 +151,4 @@ Make sure that you include leading and trailing slashes for the values.
148151

149152
## Search
150153

151-
Search functionality is integrated with [Algolia Docsearch](https://docsearch.algolia.com/). There’s a [**timber.json**](https://github.com/algolia/docsearch-configs/blob/master/configs/timber.json) file with all the configuration for Algolia to build a search index. If something isn’t working, you should make a pull request for updating that file.
154+
Search functionality is integrated with [Algolia Docsearch](https://docsearch.algolia.com/). There’s a [**timber.json**](https://github.com/algolia/docsearch-configs/blob/master/configs/timber.json) file with all the configuration for Algolia to build a search index. If something isn’t working, you should make a pull request for updating that file.

0 commit comments

Comments
 (0)