-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Labels
good first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is neededsig:collectorsig:collector:refactorThese issues are part of the Collector documentation refactoring project.These issues are part of the Collector documentation refactoring project.triage:acceptedIssue has been accepted and a PR can be createdIssue has been accepted and a PR can be created
Milestone
Description
What needs to be changed?
Copy edit the landing page and three child pages in the Building custom components section.
What is the name + path of the page that needs changed?
https://opentelemetry.io/docs/collector/building/ + child pages, but this path will change if #8360 is complete.
Additional context:
Conduct a general copy edit, looking for typos, missing words, and bad formatting. Also edit the section for the following things:
- Style guide compliance
- Use sentence case subheadings. Only proper nouns should be capitalized after the first word of the heading.
- Capitalize OpenTelemetry proper nouns and de-capitalize general nouns (for example, Collector is capitalized when referring to the OTel Collector, but signal names such as span or trace are not capitalized.
- Use “for example” instead of e.g. and “in other words” (or similar) for i.e.
- Substitute “using”, “with”, “by”, etc. for "via"
- Use short code admonitions instead of Markdown notes
- Clarity - rewrite if necessary
- Grammar
- Unnecessary passive voice
- Unnecessary adverbs and general wordiness
- Future tense - should almost always be present tense
- Tone/voice continuity - look for any obvious shifts in tone or voice and correct them
- Request a review for accuracy from the Collector SIG.
Tip:
React
with 👍 to help prioritize this issue. Please use comments to provide useful
context, avoiding +1 or me too, to help us triage it. Learn more
here.
Metadata
Metadata
Assignees
Labels
good first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is neededsig:collectorsig:collector:refactorThese issues are part of the Collector documentation refactoring project.These issues are part of the Collector documentation refactoring project.triage:acceptedIssue has been accepted and a PR can be createdIssue has been accepted and a PR can be created
Type
Projects
Status
No status
Status
In progress