Conversation
klizhentas
left a comment
There was a problem hiding this comment.
I've done the first pass. Monumental work. General notes:
- Let's move all the content to Kubernetes access
- Let's split getting started, architecture and reference to separate docs
Ping me if you have any questions, would be happy to discuss over quick chat.
93a89a4 to
9d711a0
Compare
|
@klizhentas I've addressed pretty much all your feedback. Just need to write the migration guide and add some details on |
0660388 to
3ad7f87
Compare
|
|
|
@klizhentas Please re-review. |
|
Migration guide is now added. Docs live at https://teleport-docs-next-git-gus-helmdocs-gravitational.vercel.app/docs/ver/7.0/kubernetes-access/helm/guides/ |
e45091e to
b5acf04
Compare
|
@klizhentas Ping |
|
@webvictim will review tomorrow, thanks Gus! |
klizhentas
left a comment
There was a problem hiding this comment.
Overall, solid work, great attention to detail and props for taking care of cert-manager, migration and reference. High quality work, @webvictim well done.
I have a ton of nitpicks, mostly styling and using new features of the docs. Once applied, should be good to go.
There was a problem hiding this comment.
This does not render as a header, so hard to separate sections from each other. Please try this
## Chart `teleport-cluster`
There was a problem hiding this comment.
This is annoying - it used to render as a header but it stopped when I rebased so clearly this was changed at some point.
There was a problem hiding this comment.
This has the same level as the helm chart, but is a property of the chart. Let's try this instead and see how it renders
### Parameter `clusterName`
This will also make TOC manageable., right now it overflows.
There was a problem hiding this comment.
A multi-level TOC which uses the level of the header comments would be really nice, or some other way to auto-generate a TOC at the top of the file rather than using the side nav.
There was a problem hiding this comment.
Nit: sometimes we use $ and sometimes not, probably remove elsewhere too?
There was a problem hiding this comment.
Yeah you're right. My intention is to use $ whenever there is example output after the command (to separate the two) but this one was inconsistent.
|
@klizhentas This has addressed the majority of your nits. I'm wondering if there's a better way we can handle the TOC on the reference pages rather than having to manually generate one. Also, the formatting of |
|
@webvictim thank you, will review today. |
|
Thanks @klizhentas - could you take a look at #6344 too please? Andrew’s already reviewed the code so mostly needs a code owner stamp. |
Updates #5582
Still a work in progress.