Skip to content

Write "how to" Guides #1961

@tigrannajaryan

Description

@tigrannajaryan

As part of open-telemetry/community#847 the TC with the help of the experienced members will write "How to" guides that explain how to submit proposals and make changes happen in the specification repo. It is currently not clear for many members who want to add to the specification how to navigate this process.

We would like to have "How to" guides to be part of our "Contributing" documentation. The guides need to be specific, describe the process from start to the end (success or rejection) for each particular class of changes (e.g. "How to add a semantic convention"). It is important for contributors to understand clear actions they can take to progress a contribution. The aim is to have minimum ambiguity, but also leave enough flexibility in the process to make it useful.

Here is the preliminary list of topics for guides (create an issue to track each individually):

I also encourage TC, spec approvers or any other member to propose additional topics for "how to" guides.

Current members who have experience with the topic will write the guides (likely will be done by TC members and spec approvers).

Metadata

Metadata

Assignees

Labels

spec:miscellaneousFor issues that don't match any other spec label

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions