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: Rename 'Setup' to 'Get started' and 'Start' to 'Run' #6112

Merged
merged 4 commits into from
Jan 11, 2024

Conversation

thampiotr
Copy link
Contributor

@thampiotr thampiotr commented Jan 11, 2024

PR Description

As part of improving docs structure, this PR moves the flow/setup/ folder to flow/get-started. This is following the agreed new guidelines from writing-docs.md.

This also renames "Start" to "Run" as the former was clashing with "Get started".

Checked with make docs that there are no dead links.
Verified that the aliases for moved pages still works with curl.

image

This is the last step 🎉
Fixes #5949

@thampiotr thampiotr requested review from rfratto and ptodev January 11, 2024 12:05
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Pages in start/ folder are new, created in #6087, were not released yet anywhere other than next docs preview. So we don't need to add extra backwards compatibility aliases here.

@thampiotr thampiotr marked this pull request as ready for review January 11, 2024 12:10
@rfratto
Copy link
Member

rfratto commented Jan 11, 2024

Let me know if I'm nitpicking too hard here, but I find the combination of a folder called "get started" and a subfolder called "start" potentially confusing; people might think that "start" means "start here" (even if it's the second item in the list).

Should we rename start to another verb to avoid this potential confusion? Or is this too much of a stretch?

(cc @clayton-cornell)

@thampiotr
Copy link
Contributor Author

@rfratto yeah, it could be better. Maybe "Run"? The instructions inside the start/ folder actually talk about start/stop/restart. Let me know what you think about "Run" - I can make this changes now to reduce the back-n-forth.
Those are still new pages, so should be easier to rename.

@rfratto
Copy link
Member

rfratto commented Jan 11, 2024

run makes sense to me personally 👍

@thampiotr thampiotr changed the title Rename 'Setup' to 'Get started' and fix links Docs: Rename 'Setup' to 'Get started' and 'Start' to 'Run' Jan 11, 2024
@thampiotr
Copy link
Contributor Author

@rfratto it's done now :) I think we're ready to merge this and I can address any follow-up comments from @clayton-cornell if needed.

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 from my end.

@thampiotr thampiotr merged commit 2ba4488 into main Jan 11, 2024
10 checks passed
@thampiotr thampiotr deleted the thampiotr/docs-reorg-7 branch January 11, 2024 14:50
@clayton-cornell
Copy link
Contributor

Run is good from my side... we might need to tweak the topic titles/headings here and there but it makes sense (and was something I was considering suggesting late yesterday as well... just hadn't got to it)

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Jan 11, 2024
BarunKGP pushed a commit to BarunKGP/grafana-agent that referenced this pull request Feb 20, 2024
)

* Rename 'Setup' to 'Get started' and fix links

* Fix links

* fix links

* Rename 'start' folder to 'run'
@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.
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
Development

Successfully merging this pull request may close these issues.

Create a clear space in docs hierarchy for the task-based docs
3 participants