Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 4 additions & 4 deletions hack/api-docs/generate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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" \
"$@"
}

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down