-
Notifications
You must be signed in to change notification settings - Fork 487
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
Conversation
There was a problem hiding this comment.
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.
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) |
@rfratto yeah, it could be better. Maybe "Run"? The instructions inside the |
run makes sense to me personally 👍 |
@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. |
There was a problem hiding this 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.
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) |
PR Description
As part of improving docs structure, this PR moves the
flow/setup/
folder toflow/get-started
. This is following the agreed new guidelines fromwriting-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
.This is the last step 🎉
Fixes #5949