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

Move "configuration language" section to "concepts" #6033

Merged
merged 4 commits into from
Jan 4, 2024
Merged

Move "configuration language" section to "concepts" #6033

merged 4 commits into from
Jan 4, 2024

Conversation

thampiotr
Copy link
Contributor

PR Description

This is part of adopting the new documentation structure as defined here: https://github.com/grafana/agent/blob/main/docs/developer/writing-docs.md#concepts

  • The Configuration Language seems to best fit under "Concepts" and thus I'm moving it there as part of this PR.
  • There is already a short page on configuration language under the Concepts section. I've folded it into the index of the Config Language landing page.

@thampiotr thampiotr marked this pull request as ready for review January 2, 2024 13:20
@thampiotr thampiotr requested a review from rfratto January 2, 2024 13:21
rfratto
rfratto reviewed Jan 2, 2024
View reviewed changes
Copy link
Member

@rfratto rfratto left a comment

Choose a reason for hiding this comment

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

LGTM for the most part, but I'm fairly sure that we need to change the alias blocks of the old pages so old links to the config language pages continue to work.

docs/sources/flow/_index.md Outdated Show resolved Hide resolved
docs/sources/flow/concepts/config-language/_index.md Outdated Show resolved Hide resolved
docs/sources/flow/concepts/config-language/_index.md Outdated Show resolved Hide resolved
@thampiotr thampiotr self-assigned this Jan 2, 2024
@thampiotr thampiotr force-pushed the thampiotr/docs-reorg-part-2 branch from 3335690 to d7fb029 Compare January 2, 2024 13:47
@thampiotr thampiotr force-pushed the thampiotr/docs-reorg-part-2 branch from d7fb029 to 98410be Compare January 2, 2024 14:08
@thampiotr thampiotr requested a review from rfratto January 2, 2024 14:12
rfratto
rfratto approved these changes Jan 2, 2024
View reviewed changes
Copy link
Member

@rfratto rfratto left a comment

Choose a reason for hiding this comment

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

LGTM. I'm a little nervous about the relative aliases, but if @jdbaldry doesn't respond or know we can merge and return to this later once Clayton is back next week.

jdbaldry
jdbaldry reviewed Jan 2, 2024
View reviewed changes
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

I haven't checked all the aliases in these files as I'm hoping my feedback on the first files might inform the changes to the rest.

Let me know if I can help explain anything in more detail. Some useful documentation is in https://grafana.com/docs/writers-toolkit/write/front-matter/#test-an-alias and https://grafana.com/docs/writers-toolkit/write/front-matter/#versioned-projects

docs/sources/flow/concepts/config-language/_index.md Outdated Show resolved Hide resolved
docs/sources/flow/concepts/config-language/_index.md Outdated Show resolved Hide resolved
@thampiotr thampiotr requested a review from jdbaldry January 2, 2024 16:14
jdbaldry
jdbaldry reviewed Jan 2, 2024
View reviewed changes
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

All new aliases look good to me, I think we are just missing one for the deleted file folded into /docs/slources/flow/config-language/_index.md

docs/sources/flow/concepts/config-language/_index.md Show resolved Hide resolved
@thampiotr thampiotr requested a review from jdbaldry January 3, 2024 10:26
@thampiotr thampiotr merged commit 058695a into main Jan 4, 2024
10 checks passed
@thampiotr thampiotr deleted the thampiotr/docs-reorg-part-2 branch January 4, 2024 08:44
hainenber pushed a commit to hainenber/agent that referenced this pull request Jan 6, 2024
@thampiotr @hainenber
Move "configuration language" section to "concepts" (grafana#6033)
4aaf58c 
* Move 'configuration language' section to 'concepts'

* fix relative aliases

* add aliases of the deleted page

* add missing alias
@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Jan 8, 2024
BarunKGP pushed a commit to BarunKGP/grafana-agent that referenced this pull request Feb 20, 2024
@thampiotr @BarunKGP
Move "configuration language" section to "concepts" (grafana#6033)
c903505 
* Move 'configuration language' section to 'concepts'

* fix relative aliases

* add aliases of the deleted page

* add missing alias
@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

@jdbaldry jdbaldry jdbaldry approved these changes

@rfratto rfratto rfratto approved these changes

@clayton-cornell clayton-cornell Awaiting requested review from clayton-cornell clayton-cornell is a code owner

Assignees

@thampiotr thampiotr

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.
4 participants
@thampiotr @rfratto @jdbaldry @clayton-cornell