Skip to content

Commit

Permalink
Add detailed explanation of docs mirroring (#547)
Browse files Browse the repository at this point in the history
  • Loading branch information
shelbyspees authored Apr 19, 2021
1 parent b042435 commit 7c1dcce
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
22 changes: 20 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Contributing to OpenTelemetry.io

## Dev Setup

* Fork and clone the repository
Expand All @@ -15,7 +17,24 @@ A few notes to be aware of:

## Mirrored Documentation

The per-language 'getting started' guides are mirrored to each language's repository. Once a release occurs for a SIG, an issue or PR should be created in this repository to update the content in `/content/en/docs/<language>` with the changes.
### Language-specific documentation (under `/content/en/docs/<language>`)

The per-language API, SDK, and "Getting Started" documentation is hosted in each language's repository under the `website_docs` directory.
The content of those docs is mirrored to each language's directory in this repository (open-telemetry/opentelemetry.io): [`/content/en/docs/<language>`](./content/en/docs/).

Content updates for those pages should take place in your language's repository.
That includes changes to:

* the "Status and Releases" section in `_index.md`
* the "Getting Started" page, if it exists
* any language-specific instrumentation pages
* any other pages that live under that language's section on [the docs site](https://opentelemetry.io/docs/)

Once a release occurs for a SIG or any content gets updated in those docs, an issue or PR should be created in this repository to pull the latest into `/content/en/docs/<language>`.

### Anything else under `content/`

All other content, including entries in the [Registry](https://opentelemetry.io/registry/), is hosted in this repository and can be updated here.

## Deploy previews

Expand All @@ -33,4 +52,3 @@ changes.

> Site administrators can access the admin interface
> [here](https://app.netlify.com/sites/opentelemetry/overview).
5 changes: 4 additions & 1 deletion content/en/docs/contribution-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ OpenTelemetry is an open source project, and we gladly accept new contributions

## Contributing to the OpenTelemetry Documentation

Individual SIGs may maintain documentation above and beyond what is offered here, but we strive for accurate general guidance on using the project from our main website, located at <https://github.com/open-telemetry/opentelemetry.io>
Individual SIGs may maintain documentation above and beyond what is offered here, but we strive for accurate general guidance on using the project from our main website, located at <https://github.com/open-telemetry/opentelemetry.io>.

The per-language API, SDK, and "Getting Started" documentation is hosted in each language's GitHub repository.
For more information, [see the Mirrored Documentation section](https://github.com/open-telemetry/opentelemetry.io/blob/main/CONTRIBUTING.md#mirrored-documentation) of the website repository's CONTRIBUTING.md file.

### Contributor License Agreement

Expand Down

0 comments on commit 7c1dcce

Please sign in to comment.