Revisit documentation #30166
Comments
|
Any documentation PRs are welcome! To make it easiest on reviewers, please keep content and re-organization changes as distinct as possible. It's a lot easier to review if you know it's just content being moved vs. moved and modified. Sometimes it's impossible to separate, but just a thought. Some kind of landing page would be helpful to direct users to whatever information they're looking for. Obviously one big document is hard to process, but it at least allows one central search of contents, so we want to make sure we don't make it harder to find what someone's looking for by breaking it up into different files. Specifics can probably be discussed in PRs. |
|
We could get started with this docs PR for some testing guidance I could see such being relevant to discussion in ex this PR |
**Description:** Adds some documentation around test targets to a new (to this project) `docs` folder, similar to what we have in `opentelemetry-collector` (upstream) **Link to tracking Issue:** [`30166`](#30166) **Testing:** N/A **Documentation:** Adds documentation to `docs` folder but not linked to `CONTRIBUTORS.md` until we get some discussion rolling about how to potentially reorganize such --------- Co-authored-by: bryan-aguilar <46550959+bryan-aguilar@users.noreply.github.com>
…emetry#30172) **Description:** Adds some documentation around test targets to a new (to this project) `docs` folder, similar to what we have in `opentelemetry-collector` (upstream) **Link to tracking Issue:** [`30166`](open-telemetry#30166) **Testing:** N/A **Documentation:** Adds documentation to `docs` folder but not linked to `CONTRIBUTORS.md` until we get some discussion rolling about how to potentially reorganize such --------- Co-authored-by: bryan-aguilar <46550959+bryan-aguilar@users.noreply.github.com>
|
This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping |
|
This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping |
|
This issue has been closed as inactive because it has been stale for 120 days with no activity. |
Component(s)
No response
Describe the issue you're reporting
Imo
CONTRIBUTING.mdis getting a bit big. I saw that the upstreamopentelemetry-collectorhas adocsfolder and was wondering about possibly doing similar on our side.I wanted to document some things around running integration tests and build constraints that I didn't see elsewhere. I can instead make a PR against
CONTRIBUTING.mdif that's preferable.I'll also note that some
opentelemetry-collector-contribspecific documentation lives inopentelemetry-collector(ex stuff around mdatagen). While I'd love to see mdatagen upstreamed, I'm of the opinion said docs would better live here (maybe with a link from upstream ?) until we merge it upstream.Lastly, I'd like to reuse these markdown files for the opentelemetry.io site if possible, but that's for the future.
In general I want to connect with other people in the collector-contrib and collector spaces to improve documentation, and intend to use this as a centralized place to discuss such unless/until we get more inertia and consensus around documentation improvements..
The text was updated successfully, but these errors were encountered: