diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ab229692..eb7c4dfd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,15 +31,16 @@ The site documentation is written in Markdown and compiled with 1. Install mkdocs and required plugins: ``` - pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin mkdocs-macros-plugin + pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin mkdocs-macros-plugin mike ``` -2. To build the docs, run `make docs`. +2. To build the docs, run `make docs` 3. To deploy the docs locally, run `make local-docs` ## Mentorship - [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers! + ## Contact Information - [Slack](https://kubernetes.slack.com/messages/sig-network) diff --git a/hack/api-docs/generate.sh b/hack/api-docs/generate.sh index d3c30f88..651e5043 100755 --- a/hack/api-docs/generate.sh +++ b/hack/api-docs/generate.sh @@ -25,8 +25,8 @@ GOPATH=${GOPATH:-$(go env GOPATH)} GOBIN=${GOBIN:-$(go env GOBIN)} GOBIN=${GOBIN:-${GOPATH}/bin} -readonly HERE=$(cd $(dirname $0) && pwd) -readonly REPO=$(cd ${HERE}/../.. && pwd) +readonly HERE=$(cd "$(dirname $0)" && pwd) +readonly REPO=$(cd "${HERE}/../.." && pwd) gendoc::build() { go install github.com/ahmetb/gen-crd-api-reference-docs @@ -37,8 +37,8 @@ gendoc::exec() { local readonly confdir="${REPO}/hack/api-docs" ${GOBIN}/gen-crd-api-reference-docs \ - -template-dir ${confdir} \ - -config ${confdir}/config.json \ + -template-dir "${confdir}" \ + -config "${confdir}/config.json" \ "$@" } diff --git a/mkdocs.yml b/mkdocs.yml index 28dff59c..36e56d57 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,10 +64,10 @@ nav: - Template: npeps/npep-95.md - Provisional: - npeps/npep-122.md - # - Implementable: + - Implementable: + - npeps/npep-133-fqdn-egress-selector.md - Experimental: - npeps/npep-126-egress-traffic-control.md - - npeps/npep-133-fqdn-egress-selector.md - Standard: - npeps/npep-137-conformance-profiles.md # - Declined: