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

[editorial] Ensure common section has a README #2479

Merged

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Apr 8, 2022

/cc @austinlparker @tigrannajaryan @carlosalberto

@tigrannajaryan
Copy link
Member

The common.md content is probably not a great fit for a README. I think we can allow this PR since it will result in a better than currently situation on the website, but we probably will need to re-work the README after that to make the content more suitable as an introduction to what a "common" section in the specification supposedly should be.

Question: do we need a README file in every sub-directory under the "specification" directory? Most sub-directories currently don't have one.

@chalin
Copy link
Contributor Author

chalin commented Apr 8, 2022

The common.md content is probably not a great fit for a README. I think we can allow this PR since it will result in a better than currently situation on the website

Great!

Question: do we need a README file in every sub-directory under the "specification" directory? Most sub-directories currently don't have one.

Yes, in order to fix

every section will need a README. I'm available to help here: e.g., I submit a first PR that adds a README (with only a title) to each section that doesn't have such a file. That'll act as a placeholder that can be built upon via subsequent PRs. WDYT?

@tigrannajaryan
Copy link
Member

every section will need a README. I'm available to help here: e.g., I submit a first PR that adds a README (with only a title) to each section that doesn't have such a file. That'll act as a placeholder that can be built upon via subsequent PRs. WDYT?

Yes, sounds good. Some sub-directories have good candidates for README (e.g. most that have an "overview.md" should work as README).

@reyang reyang added the editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. label Apr 8, 2022
@reyang reyang merged commit f124b21 into open-telemetry:main Apr 8, 2022
MrAlias added a commit to signalfx/gdi-specification that referenced this pull request Apr 18, 2022
MrAlias added a commit to signalfx/gdi-specification that referenced this pull request Apr 19, 2022
@chalin chalin deleted the chalin-mbp-subm-common-index-2022-04-08 branch May 16, 2022 18:42
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants