generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 213
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
28 changed files
with
4,389 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| { | ||
| "hideMemberFields": [ | ||
| "TypeMeta" | ||
| ], | ||
| "hideTypePatterns": [ | ||
| "ParseError$", | ||
| "List$", | ||
| "ReferencePolicy$" | ||
| ], | ||
| "externalPackages": [ | ||
| { | ||
| "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$", | ||
| "docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", | ||
| "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#{{ lower .TypeIdentifier }}-{{ arrIndex .PackageSegments -1 }}-{{ arrIndex .PackageSegments -2 }}" | ||
| } | ||
| ], | ||
| "typeDisplayNamePrefixOverrides": { | ||
| "k8s.io/api/": "Kubernetes ", | ||
| "k8s.io/apimachinery/pkg/apis/": "Kubernetes " | ||
| }, | ||
| "markdownDisabled": false | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| #!/usr/bin/env bash | ||
| # Copyright 2023 The Kubernetes Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| set -o errexit | ||
| set -o nounset | ||
| set -o pipefail | ||
|
|
||
| ROOT_DIR="$(dirname "${BASH_SOURCE[0]}")/../.." | ||
|
|
||
| function gendoc() { | ||
| local confdir="${ROOT_DIR}/hack/api_docs" | ||
|
|
||
| go run github.com/ahmetb/gen-crd-api-reference-docs \ | ||
| -template-dir "${confdir}" \ | ||
| -config "${confdir}/config.json" \ | ||
| "$@" | ||
| } | ||
|
|
||
| if [[ "$#" != "1" ]]; then | ||
| echo "usage: generate.sh OUTFILE" | ||
| exit 2 | ||
| fi | ||
|
|
||
| gendoc \ | ||
| -api-dir "sigs.k8s.io/kwok/pkg/apis/" \ | ||
| -out-file "${1}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| {{ define "members" }} | ||
|
|
||
| {{ range .Members }} | ||
| {{ if not (hiddenMember .) }} | ||
| <tr> | ||
| <td> | ||
| <code>{{ fieldName . }}</code> | ||
| <em> | ||
| {{ if linkForType .Type }} | ||
| <a href="{{ linkForType .Type }}"> | ||
| {{ typeDisplayName .Type }} | ||
| </a> | ||
| {{ else }} | ||
| {{ typeDisplayName .Type }} | ||
| {{ end }} | ||
| </em> | ||
| </td> | ||
| <td> | ||
| {{ if fieldEmbedded . }} | ||
| <p> | ||
| (Members of <code>{{ fieldName . }}</code> are embedded into this type.) | ||
| </p> | ||
| {{ end }} | ||
|
|
||
| {{ if isOptionalMember . }} | ||
| <em>(Optional)</em> | ||
| {{ end }} | ||
|
|
||
| {{ safe (renderComments .CommentLines) }} | ||
|
|
||
| {{ if and (eq (.Type.Name.Name) "ObjectMeta") }} | ||
| Refer to the Kubernetes API documentation for the fields of the | ||
| <code>metadata</code> field. | ||
| {{ end }} | ||
|
|
||
| {{ if or (eq (fieldName .) "spec") }} | ||
| <table> | ||
| {{ template "members" .Type }} | ||
| </table> | ||
| {{ end }} | ||
| </td> | ||
| </tr> | ||
| {{ end }} | ||
| {{ end }} | ||
|
|
||
| {{ end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| {{ define "packages" }} | ||
|
|
||
| --- | ||
| title: API reference | ||
| bookToc: false | ||
| --- | ||
|
|
||
| {{ "\n" }} | ||
|
|
||
| {{ with .packages }} | ||
| <p>Packages:</p> | ||
| <ul> | ||
| {{ range . }} | ||
| <li> | ||
| <a href="#{{ packageAnchorID . }}">{{ packageDisplayName . }}</a> | ||
| </li> | ||
| {{ end }} | ||
| <li> | ||
| <p> | ||
| <a href="#references">References</a> | ||
| </p> | ||
| </li> | ||
| </ul> | ||
|
|
||
| {{ end }} | ||
|
|
||
| {{ range .packages }} | ||
| <h2 id="{{ packageAnchorID . }}"> | ||
| {{ packageDisplayName . }} | ||
| <a href="#{{ packageAnchorID . }}"> #</a> | ||
| </h2> | ||
|
|
||
| {{ with (index .GoPackages 0 ) }} | ||
| {{ with .DocComments }} | ||
| <div> | ||
| {{ safe (renderComments .) }} | ||
| </div> | ||
| {{ end }} | ||
| {{ end }} | ||
|
|
||
| Resource Types: | ||
| <ul> | ||
| {{- range (visibleTypes (sortedTypes .Types)) -}} | ||
| {{ if not (typeReferences .) }} | ||
| <li> | ||
| <a href="{{ linkForType . }}">{{ typeDisplayName . }}</a> | ||
| </li> | ||
| {{- end }} | ||
| {{- end -}} | ||
| </ul> | ||
|
|
||
| {{ range (visibleTypes (sortedTypes .Types)) }} | ||
| {{ if not (typeReferences .) }} | ||
| {{ template "type" . }} | ||
| {{ end }} | ||
| {{ end }} | ||
|
|
||
| {{ end }} | ||
|
|
||
| <h2 id="references"> | ||
| References | ||
| <a href="#references"> #</a> | ||
| </h2> | ||
|
|
||
| {{ range .packages }} | ||
| {{ range (visibleTypes (sortedTypes .Types)) }} | ||
| {{ if (typeReferences .) }} | ||
| {{ template "type" . }} | ||
| {{ end }} | ||
| {{ end }} | ||
| {{ end }} | ||
|
|
||
| {{ end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| {{ define "type" }} | ||
|
|
||
| <h3 id="{{ anchorIDForType . }}"> | ||
| {{ .Name.Name }} | ||
| {{ if eq .Kind "Alias" }}(<code>{{ .Underlying }}</code> alias){{ end }} | ||
| <a href="#{{ anchorIDForType . }}"> #</a> | ||
| </h3> | ||
| {{ with (typeReferences .) }} | ||
| <p> | ||
| <em>Appears on: </em> | ||
| {{ $prev := "" }} | ||
| {{ range . }} | ||
| {{ if $prev }}, {{ end }} | ||
| {{ $prev = . }} | ||
| <a href="{{ linkForType . }}">{{ typeDisplayName . }}</a> | ||
| {{ end }} | ||
| </p> | ||
| {{ end }} | ||
|
|
||
| <p> | ||
| {{ safe (renderComments .CommentLines) }} | ||
| </p> | ||
|
|
||
| {{ with (constantsOfType .) }} | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Value</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| {{ range . }} | ||
| <tr> | ||
| <td><code>{{ typeDisplayName . }}</code></td> | ||
| <td>{{ safe (renderComments .CommentLines) }}</td> | ||
| </tr> | ||
| {{ end }} | ||
| </tbody> | ||
| </table> | ||
| {{ end }} | ||
|
|
||
| {{ if .Members }} | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Field</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| {{ if not (typeReferences .) }} | ||
| <tr> | ||
| <td> | ||
| <code>apiVersion</code> | ||
| string | ||
| </td> | ||
| <td> | ||
| <code> | ||
| {{ apiGroup . }} | ||
| </code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <code>kind</code> | ||
| string | ||
| </td> | ||
| <td><code>{{ .Name.Name }}</code></td> | ||
| </tr> | ||
| {{ end }} | ||
| {{ template "members" . }} | ||
| </tbody> | ||
| </table> | ||
| {{ end }} | ||
|
|
||
| {{ end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| #!/usr/bin/env bash | ||
| # Copyright 2023 The Kubernetes Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| set -o errexit | ||
| set -o nounset | ||
| set -o pipefail | ||
|
|
||
| ROOT_DIR="$(dirname "${BASH_SOURCE[0]}")/.." | ||
|
|
||
| function check() { | ||
| echo "Update api docs" | ||
| ./hack/api_docs/generate.sh site/content/en/docs/generated/apis.md | ||
| } | ||
|
|
||
| cd "${ROOT_DIR}" | ||
|
|
||
| check || exit 1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.