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

Docs: remove duplicated arch info from the overview section #3873

Merged
merged 3 commits into from
Jun 21, 2021

Conversation

KMiller-Grafana
Copy link
Contributor

What this PR does / why we need it: I intend to revise and update the Overview section of the docs. As a first step towards that, I have removed the architecture info from the Overview section. The prose in the Overview section was mostly a duplicate of that in the Architecture section.

Duplicating prose or info tends to cause stale info, as writers often update one location without realizing that info might need to be updated in more than one location.

Copy link
Member

@owen-d owen-d left a comment

Choose a reason for hiding this comment

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

Looks good - left a few comments then we can merge

docs/sources/architecture/_index.md Outdated Show resolved Hide resolved
docs/sources/architecture/distributor.md Outdated Show resolved Hide resolved
KMiller-Grafana and others added 2 commits June 21, 2021 14:48
Co-authored-by: Owen Diehl <ow.diehl@gmail.com>
Co-authored-by: Owen Diehl <ow.diehl@gmail.com>
@owen-d owen-d merged commit 551b153 into grafana:main Jun 21, 2021
@KMiller-Grafana KMiller-Grafana deleted the docs/update-arch-section branch July 22, 2021 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants