Prepare for v1.21 + indentation + local common definitions

[feloy]

Preview at https://deploy-preview-26413--kubernetes-io-master-staging.netlify.app/docs/reference/kubernetes-api/

• Prepares the API Reference documentation for v1.21

• Moves some Definitions from Common Definitions page to specific page (ex Handler, NodeAffinity, etc moved to Pod page).

• Enables deep indentation for nested fields.

Pages generated by kubernetes-sigs/reference-docs#207

[feloy]

/assign sftim

[feloy]

/assign kbhawkey

[netlify]

Deploy preview for kubernetes-io-master-staging ready!

Built with commit a6c947a

https://deploy-preview-26413--kubernetes-io-master-staging.netlify.app

[kbhawkey]

Hi @feloy . I am looking at the generated pages (and will read through the source changes). Some feedback:

• I think it is a good idea to reference an issue for any medium-sized changes (relocation of definitions).
• Should these changes merge into the dev-1.21 branch just before the release date? Or do you want these changes to go in now (master branch)?
• Should the links to the original object definitions redirect from the "Common Definitions" page to an individual resource page?

A couple of page previews:
https://deploy-preview-26413--kubernetes-io-master-staging.netlify.app/docs/reference/kubernetes-api/workloads-resources/pod-v1/#NodeAffinity

https://deploy-preview-26413--kubernetes-io-master-staging.netlify.app/docs/reference/kubernetes-api/workloads-resources/pod-v1/#Handler

Related to issue #25505.

[feloy]

Hi @feloy . I am looking at the generated pages (and will read through the source changes). Some feedback:

• I think it is a good idea to reference an issue for any medium-sized changes (relocation of definitions).
• Should these changes merge into the dev-1.21 branch just before the release date? Or do you want these changes to go in now (master branch)?

I'm not sure of the implications. My idea is to wait for the definitive swagger definition of v1.21 before to merge this PR. The definitive swagger won't come before the Release Candidates probably.

• Should the links to the original object definitions redirect from the "Common Definitions" page to an individual resource page?

Do you mean making redirections so links created in the actual pages are not broken when this PR is merged? As the pages are not crawled by robots, do you think it is necessary?

A couple of page previews:
https://deploy-preview-26413--kubernetes-io-master-staging.netlify.app/docs/reference/kubernetes-api/workloads-resources/pod-v1/#NodeAffinity

https://deploy-preview-26413--kubernetes-io-master-staging.netlify.app/docs/reference/kubernetes-api/workloads-resources/pod-v1/#Handler

Related to issue #25505.

[kbhawkey]

Re: Do you mean making redirections so links created in the actual pages are not broken when this PR is merged? As the pages are not crawled by robots, do you think it is necessary?

-OK. That seems correct.

[feloy]

New version of the reference reflecting the changes in v1.21-beta.0

• CronJob v2alpha1 removed

[kbhawkey]

Hi @feloy .
What do you think about publishing these changes to the dev-1.21 branch?
You could use the latest release candidate of the spec and then update the files after the release if needed?
That way, this documentation is included in the 1.21 reference documentation set.
What do you think?

[feloy]

Hi @kbhawkey . I have based the PR on the dev-1.21 branch.

I'll watch if there are any changes to the spec after the docs release.

[reylejano]

/milestone 1.21

[k8sio-netlify-preview-bot]

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit f7943d8

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/6066b8c981c09e000764b34e

[reylejano]

Hi @feloy, are the steps documented to prepare the API Reference documentation for 1.21?
Should this process be included in future release cycles and conducted by the release docs team?
We can add the steps to prepare the API Reference documentation in the release docs role handbook

[feloy]

Hi @reylejano

The process to prepare the API reference doc has been briefly described in the README.md file of this k/website repository (https://github.com/kubernetes/website/blob/master/README.md#building-the-api-reference-pages) and in the README of the generator (https://github.com/kubernetes-sigs/reference-docs/blob/master/gen-resourcesdocs/README.md).

For the 1.21 release, all the needed work is included in this PR, so I think there is nothing to do more than merging it.

For the next releases, adding more detailed information to the release docs role handbook would be nice.

[kbhawkey]

Hi @feloy .
I ran through several resources and common definitions. Looks good.
One thing I noted (Markdown list not rendering):
https://deploy-preview-26413--kubernetes-io-master-staging.netlify.app/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#alpha-level

Do you want to keep the separate commits or rebase into one commit?

/lgtm

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: 815814db036247105751a830973c4e9a410de3ef

[feloy]

Hi @kbhawkey Thanks for the review. I just squashed my commits

[irvifa]

Feel free to unhold when the time comes
/hold

[irvifa]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: irvifa

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:

• content/en/OWNERS [irvifa]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[feloy]

Thanks @irvifa
/hold cancel