Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write "how to" Guides #1961

Open
5 tasks
Tracked by #847
tigrannajaryan opened this issue Sep 24, 2021 · 2 comments
Open
5 tasks
Tracked by #847

Write "how to" Guides #1961

tigrannajaryan opened this issue Sep 24, 2021 · 2 comments
Assignees
Labels
spec:miscellaneous For issues that don't match any other spec label

Comments

@tigrannajaryan
Copy link
Member

tigrannajaryan commented Sep 24, 2021

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

@tigrannajaryan
Copy link
Member Author

I am going to break this down into individual issues per guide.

@tigrannajaryan
Copy link
Member Author

tigrannajaryan commented Oct 5, 2021

OK, broken down into individual issues and linked from this summary issue. Please vote for individual issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:miscellaneous For issues that don't match any other spec label
Projects
None yet
Development

No branches or pull requests

2 participants