-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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: Move install section into getting started #13439
Conversation
c761d7d
to
eed1568
Compare
Signed-off-by: Ryan Northey <ryan@synca.io>
eed1568
to
6ea8cde
Compare
a99d95f
to
6ea8cde
Compare
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
@mattklein123 with these changes in terms of paths:
we could do with adding an actual install page at |
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.
Very nice. Thanks for working on this. One small comment but otherwise I love this direction!
/wait
:maxdepth: 2 | ||
|
||
building | ||
install/ref_configs |
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.
IMO the ref_configs are somewhat unrelated to building and going through the initial examples. Can you move them somewhere else?
Also, I think start.rst should be a raw TOC page without any text, as it's going to be the entry point to a lot of content. WDYT about moving all of the text in here into smaller independent pages that we can more easily sequence for the right flow?
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.
ref_configs are somewhat unrelated to building
yep, most of the stuff in the install
folder probs needs to be moved
I think start.rst should be a raw TOC page without any text
i think probably yes, but atm it is giving the section structure
could we make these changes after landing this?
the redirects, can be chained, so its ok to move and move again, and im quite up for changing this incrementally
overall tho, defo we want to be able to create a flow through the docs, and the ability to hone in on specific solutions (and SEO to get there etc), so im for moving this around more
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.
ill look and see what i can do with ref_configs
in the meantime
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.
Yeah sure I'm fine to do this incrementally as long as we agree on the overall direction. LMK if you want to play with this more or merge.
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.
lets merge it for now, and ill make some changes when i add the install page
Signed-off-by: Ryan Northey ryan@synca.io
Commit Message: docs: Move install section into getting started
Additional Description:
Further to discussion #13386 (comment) - this is a breakout PR to move the docs install section into the getting started section
Before we can safely land this we need to add docs redirects (#13436)
Risk Level:
Testing:
Docs Changes:
Release Notes:
[Optional Runtime guard:]
[Optional Fixes #Issue] touch #13386
[Optional Deprecated:]