From 7c1dcce3344b33cf1f1877a3a08ae3e8f4ef3d0e Mon Sep 17 00:00:00 2001 From: shelby spees Date: Mon, 19 Apr 2021 08:47:21 -0700 Subject: [PATCH] Add detailed explanation of docs mirroring (#547) --- CONTRIBUTING.md | 22 ++++++++++++++++++++-- content/en/docs/contribution-guidelines.md | 5 ++++- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e0eb4c1f122..da52923d89d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,5 @@ +# Contributing to OpenTelemetry.io + ## Dev Setup * Fork and clone the repository @@ -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/` with the changes. +### Language-specific documentation (under `/content/en/docs/`) + +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/`](./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/`. + +### 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 @@ -33,4 +52,3 @@ changes. > Site administrators can access the admin interface > [here](https://app.netlify.com/sites/opentelemetry/overview). - diff --git a/content/en/docs/contribution-guidelines.md b/content/en/docs/contribution-guidelines.md index 90efda0551c2..4a1c7861d2dd 100644 --- a/content/en/docs/contribution-guidelines.md +++ b/content/en/docs/contribution-guidelines.md @@ -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 +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 . + +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