Migrate site content: overview and installation #4611
Conversation
k8s-ci-robot
added
cncf-cla: yes
|
Hi @unrolled. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
k8s-ci-robot
added
the
size/L
There was a problem hiding this comment.
Doesn't need to be in this PR, but I noticed two small things about this group of pages.
- There's a placeholder page at "Documentation" subheader. kubernetes.io drops that header, so I'd say we should too.
- The subheading on the "Getting Started" page is still the boilerplate.
Note that the "Creating your first Kustomization" tutorial is net new, so you can propose changes to it if you have feedback, but you won't find additional content for it on the old site.
| @@ -4,94 +4,102 @@ linkTitle: "Install Kustomize" | |||
| date: 2022-02-27 | |||
| weight: 10 | |||
| description: > | |||
| Installing Kustomize | |||
| Kustomize can be installed in a variety of ways | |||
There was a problem hiding this comment.
This page was already migrated over in the initial scaffolding. Looks like this PR mostly reorders the sections? Why's that? I think we should order them based on utility to the average end user, so probably Binaries, then package managers, then Docker, then source?
There was a problem hiding this comment.
I wasn't sure if the existing page was up-to-date or not, so I just grabbed all the content from the CLI site and moved it over. I'll tweak the ordering 👍
| # Need go 1.13 or higher | ||
| unset GOPATH | ||
| # see https://golang.org/doc/go1.13#modules | ||
| unset GO111MODULES |
There was a problem hiding this comment.
delete from the "Need go" comment to here
|
/ok-to-test |
k8s-ci-robot
added
ok-to-test
|
@unrolled: This PR has multiple commits, and the default merge method is: merge. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
site/config.toml
Outdated
| @@ -95,6 +95,8 @@ weight = 1 | |||
| copyright_k8s = "The Kubernetes Authors" | |||
| copyright_linux = "Copyright © 2020 The Linux Foundation ®." | |||
|
|
|||
| latest_version = "v4.5.4" | |||
There was a problem hiding this comment.
I like this, but I'm worried it will immediately get stale. Options include:
- Change the name to something like "kustomize_example_version" to not imply it is necessarily the most current
- Update the release process to include bumping this. We already have a step here where we update a hardcoded string to make the example tests run against latest. If we were embedding those examples in the site (someday 🤞 ), it could make a lot of sense to sync that version with the one we advertise on the site. We could add a makefile target that does both, and update the release instructions to use that instead.
Wdyt?
There was a problem hiding this comment.
I like the idea of option 2 where we bump it during every release, but I don't think the site is ready for that yet. In the future when the site is complete we can come back and revisit this.
For now I'll change the name of the value to kustomize_example_version which is a good call! Less confusion if it strays from the official latest release.
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: KnVerey, unrolled 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
This PR is part of the larger docs clean up issue: #4338
site/content/en/docs/Getting started/installation.md. I merged all the installation instructions onto a single page as I felt the 5 sections didn't have enough content to justify their own pages. Let me know if I should break them out into separate pages.site/content/en/docs/Overview/_index.md.