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: Move install section into getting started #13439

Merged
merged 7 commits into from
Oct 9, 2020

Conversation

phlax
Copy link
Member

@phlax phlax commented Oct 8, 2020

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:]

@phlax phlax marked this pull request as draft October 8, 2020 13:56
@mattklein123 mattklein123 self-assigned this Oct 8, 2020
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax changed the title [WIP] docs: Move install section into getting started docs: Move install section into getting started Oct 9, 2020
@phlax phlax marked this pull request as ready for review October 9, 2020 09:25
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
Copy link
Member Author

phlax commented Oct 9, 2020

@mattklein123 with these changes in terms of paths:

  • /install/building has been moved to /start/building
  • the rest of /install/* has been moved to /start/install/*
  • i have remove the toc page - previously /install/install - as it was kinda superflous.

we could do with adding an actual install page at /start/install - see #13461

Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Copy link
Member

@mattklein123 mattklein123 left a 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
Copy link
Member

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?

Copy link
Member Author

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

Copy link
Member Author

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

Copy link
Member

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.

Copy link
Member Author

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

@mattklein123 mattklein123 merged commit fe14c31 into envoyproxy:master Oct 9, 2020
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.

2 participants