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.

Sign up for GitHub

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

Jump to bottom

Update Getting started topics for style, syntax, layout, spacing #5909

Merged
merged 17 commits into from
Dec 6, 2023
Merged

Update Getting started topics for style, syntax, layout, spacing #5909

merged 17 commits into from
Dec 6, 2023

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Dec 5, 2023 •
edited
Loading

PR Description

This PR updates the Install and Getting started topics, focusing on applicaiton of style, layout, spacing, and overall consistency.

Changes:

  • Use semantic line breaks instead of 80 column
  • Use lazy numbering for steps
  • Remove empty spaces at the end of lines
  • Fix cases of Flow that were missed in the conversion to a cascading variable
  • Rework text to remove most of the passive voice
  • Update the placeholder variables to match current Grafana Writer's Toolkit style
  • Correct spelling errors
  • Tidy up grammar and style used throughout the tutorials and try to align the language used in all tutorials (it's not perfect, but it's closer now)
  • Clean up and standardise the Replace the following text for placeholder variables
  • Clean up some of the step nesting - some steps were nested too deeply, and step number references no longer were valid due to changes in the website and the way numbering works.
  • Fix and standardise cross reference linking (use doc/reference where possible)

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Dec 5, 2023
@clayton-cornell clayton-cornell marked this pull request as ready for review December 6, 2023 01:01
@clayton-cornell clayton-cornell requested a review from a team December 6, 2023 01:01
@ptodev ptodev self-assigned this Dec 6, 2023
ptodev
ptodev approved these changes Dec 6, 2023
View reviewed changes
Copy link
Contributor

@ptodev ptodev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! It does look much more polished with these changes.

docs/sources/flow/getting-started/collect-opentelemetry-data.md Show resolved Hide resolved
docs/sources/flow/getting-started/migrating-from-operator.md Outdated Show resolved Hide resolved
docs/sources/flow/getting-started/migrating-from-prometheus.md Outdated Show resolved Hide resolved
docs/sources/flow/getting-started/migrating-from-promtail.md Outdated Show resolved Hide resolved
docs/sources/flow/getting-started/migrating-from-promtail.md Outdated Show resolved Hide resolved
docs/sources/flow/getting-started/migrating-from-static.md Outdated Show resolved Hide resolved
docs/sources/flow/getting-started/opentelemetry-to-lgtm-stack.md Outdated Show resolved Hide resolved
clayton-cornell and others added 2 commits December 6, 2023 07:10
@clayton-cornell @ptodev
Apply suggestions from code review
42ba914 
Co-authored-by: Paulin Todev <paulin.todev@gmail.com>
@clayton-cornell
Small tweaks from code review
882e47f
@clayton-cornell clayton-cornell merged commit 300ad36 into main Dec 6, 2023
8 checks passed
@clayton-cornell clayton-cornell deleted the docs/update-variable-style branch December 6, 2023 15:22
BarunKGP pushed a commit to BarunKGP/grafana-agent that referenced this pull request Feb 20, 2024
@clayton-cornell @ptodev @BarunKGP
Update Getting started topics for style, syntax, layout, spacing (gra…
c0d1e96 
…fana#5909)

* Fix spelling mistake

* Fix some text that was removed

* Update variable syntax in setp topics

* Update variable syntax semantic breaks spelling

* Refactoring cleanup spelling syntax

* Refactor Otel topic cleanup spelling syntax

* Refactoring layout spelling syntax spacing

* Fix some bad links

* Correct link syntax

* Cleanup variable references

* Cleanup language and spelling

* Minor corrections spelling and layout

* Fix bad syntax in caution

* Apply suggestions from code review

Co-authored-by: Paulin Todev <paulin.todev@gmail.com>

* Small tweaks from code review

---------

Co-authored-by: Paulin Todev <paulin.todev@gmail.com>
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 21, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ptodev ptodev ptodev approved these changes

Assignees

@ptodev ptodev

Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@clayton-cornell @ptodev