Add Helm tech doc analysis #332
Conversation
✅ Deploy Preview for cncf-techdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
This is great @paigecalvert, thanks! |
|
Thank you Nate will do! Just wanted to review a couple things with one of the Helm maintainers. Will ping you all soon :)
|
paigecalvert
changed the title
thisisobate
left a comment
thisisobate
left a comment
There was a problem hiding this comment.
Thanks @paigecalvert for taking out time to do this analysis. This is very well detailed and fulfills our analysis criteria.
One thing I noticed in the proposed sidebar noted in the implementaion file is the absence of the API/CLI reference. I think we should make it easier for developers to access the reference docs regardless of where it lives.
Other than that, I think this is good to go!
|
@paigecalvert I noticed you didn't add the |
Yeah can do. I was going to work on creating all of the issues as part of a follow-up iteration after checking back in with the helm team, but I can certainly get some placeholders in there now if that sounds good to you? |
|
Sounds perfect! |
|
|
||
| > AUTHOR NOTE: Link to the umbrella issue in the project's documentation repo | ||
|
|
||
| TO DO: Create umbrella issue in helm-www repo with the following boilerplate: |
There was a problem hiding this comment.
^ left a couple TO DOs for adding in the links once those issues are in github
Signed-off-by: Paige Calvert <[email protected]>
Signed-off-by: Paige Calvert <[email protected]>
Signed-off-by: Paige Calvert <[email protected]>
Signed-off-by: Paige Calvert <[email protected]>
Signed-off-by: Paige Calvert <[email protected]>
Signed-off-by: Paige Calvert <[email protected]>
|
Looks like there are some formatting and spelling issues causing CI to break. Can you try and fix those too so we can merge? @paigecalvert |
Signed-off-by: Paige Calvert <[email protected]>
Signed-off-by: Paige Calvert <[email protected]>
3 participants
No description provided.