-
Notifications
You must be signed in to change notification settings - Fork 900
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
[editorial] Ensure common section has a README #2479
Conversation
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. |
Great!
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? |
Yes, sounds good. Some sub-directories have good candidates for README (e.g. most that have an "overview.md" should work as README). |
Fix link changed by open-telemetry/opentelemetry-specification#2479
Fix link changed by open-telemetry/opentelemetry-specification#2479
common/common.md
to be the section's index file (common/README.md
)#attributes
anchors to their canonical name#attribute
(singular), under the Common page/cc @austinlparker @tigrannajaryan @carlosalberto