Docs: Rename "Development" section to "Contributing" and add instructions to update the base AMI version of Ubuntu #10455
Conversation
k8s-ci-robot
added
cncf-cla: yes
|
/retest |
|
I like the overall change. But I wonder if the development section can be a subsection of contributing. |
Yeah, that makes sense to me! |
k8s-ci-robot
added
size/M
|
/retest |
Co-authored-by: Josh Branham <[email protected]>
mkdocs.yml
Outdated
| - Ports: "development/ports.md" | ||
| - Cluster Addons & Manager : "development/addons.md" | ||
| - Contributing: | ||
| - Getting Involved and Contributing: "contributing/contributing.md" |
There was a problem hiding this comment.
This file is a bit oddly named, with the URL being https://deploy-preview-10455--kubernetes-kops.netlify.app/contributing/contributing/ If we rename it to contributing/index.md does that shorten the URL to just https://deploy-preview-10455--kubernetes-kops.netlify.app/contributing?
There was a problem hiding this comment.
Yep, that worked! @rifelpet
There was a problem hiding this comment.
| - New Kubernetes Version: "contributing/new_kubernetes_version.md" | ||
| - Our Release Process: "contributing/release.md" | ||
| - Releasing With Homebrew: "contributing/homebrew.md" | ||
| - Updating The Default Base AMI: "contributing/update_ami_versions.md" |
There was a problem hiding this comment.
I do like that we have a Contributing section and a Development subsection and that it makes sense that Development is a subset of Contributing. I'm not sure it makes sense to have the entire Development section along side this handful of pages though, maybe we can put them under their own Subsection? I'm trying to think of a good name for it though... maybe some combination of these words:
common, repeat, periodic, release, processes, instructions, steps
but that would leave us with:
Contributing
- Some New Section
- Development
which might be awkward on the left side of the webpage to only have two menu items within Contributing. I don't have any good ideas here :(
There was a problem hiding this comment.
Maybe we should just rename Development to Contributing :).
There was a problem hiding this comment.
Maybe we should just rename Development to Contributing :).
Yeah I like that idea. I'll give that a try and see what it looks like
There was a problem hiding this comment.
…ing under Contributing section
|
Thanks @MoShitrit. It's ok from my point of view. Leaving final approval to @rifelpet or @olemarkus. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hakman, MoShitrit The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
moshevayner
changed the title
|
yea I like how it is setup now, thanks for doing this! |
k8s-ci-robot
added
the
lgtm
Fixes #9705
/cc: @rifelpet @hakman
I've added a new section to the top panel named
Contributingand moved the suggested topics from this comment under that section. It also made sense to me to move the main page ofcontributingfrom underWelcometo be the landing page ofContributing, hope you guys agree with this.And lastly, I added a new doc describing the process of updating the base AMI versions of Ubuntu.