Skip to content

Commit

Permalink
chore: Add notes about contributing documentation content (#86)
Browse files Browse the repository at this point in the history
* chore: Add notes about contributing documentation content

* chore: Add CODEOWNERS file
  • Loading branch information
gchtr authored Oct 2, 2024
1 parent 7612177 commit 1bfaf5b
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 13 deletions.
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* @gchtr @Levdbas
*.yml @Levdbas @nlemoine
24 changes: 14 additions & 10 deletions .github/pull_request_template.md
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 its 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. -->
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
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.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

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/).

> [!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.
<!-- TOC -->

- [Overview](#overview)
Expand All @@ -27,8 +32,6 @@ The documentation consists of:
- **Content pages** imported from the [`docs`](https://github.com/timber/timber/tree/master/docs/) folder of the Timber repository.
- **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.

If you want to **contribute content** to the documentation, you can create a pull request in the [Timber repository](https://github.com/timber/timber/).

## Writing docs

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.
Expand Down Expand Up @@ -148,4 +151,4 @@ Make sure that you include leading and trailing slashes for the values.

## Search

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.
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 comments on commit 1bfaf5b

Please sign in to comment.