diff --git a/docs/reference/_index.md b/docs/reference/_index.md index 5f1ee4b84..693cb774d 100644 --- a/docs/reference/_index.md +++ b/docs/reference/_index.md @@ -1,8 +1,8 @@ --- title: "Knative Reference Documentation" -linkTitle: "Reference and API" +linkTitle: "Reference" weight: 100 type: "docs" --- -Knative API and reference documentation. +Knative reference documentation. diff --git a/docs/reference/README.md b/docs/reference/api/README.md similarity index 96% rename from docs/reference/README.md rename to docs/reference/api/README.md index 4a63a2a22..61f9f9327 100644 --- a/docs/reference/README.md +++ b/docs/reference/api/README.md @@ -1,5 +1,3 @@ -# Knative API Reference documentation - ## View the latest release The reference documentation for the latest release of the Knative is available @@ -16,7 +14,7 @@ The API source files are located at: ## Updating API Reference docs (for Knative maintainers) The Knative API reference documentation is manually generated using the -[`gen-api-reference-docs.sh`](../../hack/) tool. If you need to generate a new +[`gen-api-reference-docs.sh`](../../../hack/) tool. If you need to generate a new version of the API docs for a recent update or for a new release, you can use the following steps. @@ -67,7 +65,7 @@ To generate a version of the API: ``` cd hack - + KNATIVE_SERVING_COMMIT=[commit_or_tag] \ KNATIVE_EVENTING_COMMIT=[commit_or_tag] \ KNATIVE_EVENTING_CONTRIB_COMMIT=[commit_or_tag] \ @@ -94,6 +92,7 @@ about requesting changes in the `knative/docs` repo. ### Example + To build a set of Knative API docs for v0.3, you can use the `v0.3.0` the tags from each of the Knative component repositories, like [Serving v0.3.0](https://github.com/knative/serving/tree/v0.3.0). If you want to diff --git a/docs/reference/api/_index.md b/docs/reference/api/_index.md new file mode 100644 index 000000000..25b21f007 --- /dev/null +++ b/docs/reference/api/_index.md @@ -0,0 +1,11 @@ +--- +title: "Knative API Reference Documentation" +linkTitle: "API" +weight: 100 +type: "docs" +aliases: +aliases: + - /docs/reference/ +--- + +{{% readfile file="README.md" %}} diff --git a/docs/reference/eventing/_index.md b/docs/reference/api/eventing/_index.md similarity index 67% rename from docs/reference/eventing/_index.md rename to docs/reference/api/eventing/_index.md index ace8350e8..e1add05a5 100644 --- a/docs/reference/eventing/_index.md +++ b/docs/reference/api/eventing/_index.md @@ -1,8 +1,10 @@ --- title: "Knative Eventing Component" linkTitle: "Eventing API" -weight: 30 +weight: 20 type: "docs" +aliases: + - /docs/reference/eventing/eventing --- {{< readfile file="eventing.md" >}} diff --git a/docs/reference/eventing/eventing-contrib-api.md b/docs/reference/api/eventing/eventing-contrib-api.md similarity index 71% rename from docs/reference/eventing/eventing-contrib-api.md rename to docs/reference/api/eventing/eventing-contrib-api.md index 53cafa016..a2b959d03 100644 --- a/docs/reference/eventing/eventing-contrib-api.md +++ b/docs/reference/api/eventing/eventing-contrib-api.md @@ -3,6 +3,8 @@ title: "Eventing-contrib Resources" linkTitle: "Eventing-contrib API" weight: 50 type: "docs" +aliases: + - /docs/reference/eventing/eventing-contrib-api --- {{< readfile file="eventing-contrib.md" >}} diff --git a/docs/reference/eventing/eventing-contrib.md b/docs/reference/api/eventing/eventing-contrib.md similarity index 100% rename from docs/reference/eventing/eventing-contrib.md rename to docs/reference/api/eventing/eventing-contrib.md diff --git a/docs/reference/eventing/eventing.md b/docs/reference/api/eventing/eventing.md similarity index 100% rename from docs/reference/eventing/eventing.md rename to docs/reference/api/eventing/eventing.md diff --git a/docs/reference/serving-api.md b/docs/reference/api/serving-api.md similarity index 68% rename from docs/reference/serving-api.md rename to docs/reference/api/serving-api.md index ba1bd7d4c..8617f6ca7 100644 --- a/docs/reference/serving-api.md +++ b/docs/reference/api/serving-api.md @@ -1,8 +1,10 @@ --- title: "Knative Serving Component" linkTitle: "Serving API" -weight: 50 +weight: 10 type: "docs" +aliases: + - /docs/reference/serving-api --- {{< readfile file="serving.md" >}} diff --git a/docs/reference/serving.md b/docs/reference/api/serving.md similarity index 100% rename from docs/reference/serving.md rename to docs/reference/api/serving.md diff --git a/docs/reference/client/README.md b/docs/reference/client/README.md deleted file mode 100644 index 9e6ea0487..000000000 --- a/docs/reference/client/README.md +++ /dev/null @@ -1 +0,0 @@ - Knative Client, `kn`, is a command line interface (CLI) for creating and managing Knative applications from the terminal. diff --git a/docs/reference/client/_index.md b/docs/reference/client/_index.md deleted file mode 100644 index 5efd2189c..000000000 --- a/docs/reference/client/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Client (Kn)" -linkTitle: "Client (Kn)" -weight: 10 -type: "docs" ---- - -{{% readfile file="README.md" %}} diff --git a/docs/reference/relnotes/_index.md b/docs/reference/relnotes/_index.md new file mode 100644 index 000000000..11509de2f --- /dev/null +++ b/docs/reference/relnotes/_index.md @@ -0,0 +1,13 @@ +--- +title: "Knative Release Notes" +linkTitle: "Release notes" +weight: 10 +type: "docs" +--- + +For details about the Knative releases, see the following pages: + +- [Knative Serving releases](https://github.com/knative/serving/releases) +- [Knative Serving Operator releases](https://github.com/knative/serving-operator/releases) +- [Knative CLI releases](https://github.com/knative/client/releases) +- [Knative Eventing releases](https://github.com/knative/eventing/releases) diff --git a/docs/concepts/resources.md b/docs/reference/resources.md similarity index 95% rename from docs/concepts/resources.md rename to docs/reference/resources.md index ec71565c4..9a53b0fd3 100644 --- a/docs/concepts/resources.md +++ b/docs/reference/resources.md @@ -1,7 +1,9 @@ --- -title: "Resources" -weight: 10 +title: "Additional resources" +weight: 100 type: "docs" +aliases: + - /docs/concepts/resources --- This page contains information about various tools and technologies that are