mirror of https://github.com/knative/docs.git
* Update reference section as per #1883 * fix link * update folder name * fixed links and peer review feedback * added aliases * added aliases * removed unnecessary heading * removed kn section * updated heading and position of optional stuff * fix note
This commit is contained in:
parent
817313dccc
commit
e6d96d0a52
|
@ -1,8 +1,8 @@
|
||||||
---
|
---
|
||||||
title: "Knative Reference Documentation"
|
title: "Knative Reference Documentation"
|
||||||
linkTitle: "Reference and API"
|
linkTitle: "Reference"
|
||||||
weight: 100
|
weight: 100
|
||||||
type: "docs"
|
type: "docs"
|
||||||
---
|
---
|
||||||
|
|
||||||
Knative API and reference documentation.
|
Knative reference documentation.
|
||||||
|
|
|
@ -1,5 +1,3 @@
|
||||||
# Knative API Reference documentation
|
|
||||||
|
|
||||||
## View the latest release
|
## View the latest release
|
||||||
|
|
||||||
The reference documentation for the latest release of the Knative is available
|
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)
|
## Updating API Reference docs (for Knative maintainers)
|
||||||
|
|
||||||
The Knative API reference documentation is manually generated using the
|
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
|
version of the API docs for a recent update or for a new release, you can use
|
||||||
the following steps.
|
the following steps.
|
||||||
|
|
||||||
|
@ -94,6 +92,7 @@ about requesting changes in the `knative/docs` repo.
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
|
<!--TODO: UPDATE THIS EXAMPLE VERSION-->
|
||||||
To build a set of Knative API docs for v0.3, you can use the `v0.3.0` the tags
|
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
|
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
|
[Serving v0.3.0](https://github.com/knative/serving/tree/v0.3.0). If you want to
|
|
@ -0,0 +1,11 @@
|
||||||
|
---
|
||||||
|
title: "Knative API Reference Documentation"
|
||||||
|
linkTitle: "API"
|
||||||
|
weight: 100
|
||||||
|
type: "docs"
|
||||||
|
aliases:
|
||||||
|
aliases:
|
||||||
|
- /docs/reference/
|
||||||
|
---
|
||||||
|
|
||||||
|
{{% readfile file="README.md" %}}
|
|
@ -1,8 +1,10 @@
|
||||||
---
|
---
|
||||||
title: "Knative Eventing Component"
|
title: "Knative Eventing Component"
|
||||||
linkTitle: "Eventing API"
|
linkTitle: "Eventing API"
|
||||||
weight: 30
|
weight: 20
|
||||||
type: "docs"
|
type: "docs"
|
||||||
|
aliases:
|
||||||
|
- /docs/reference/eventing/eventing
|
||||||
---
|
---
|
||||||
|
|
||||||
{{< readfile file="eventing.md" >}}
|
{{< readfile file="eventing.md" >}}
|
|
@ -3,6 +3,8 @@ title: "Eventing-contrib Resources"
|
||||||
linkTitle: "Eventing-contrib API"
|
linkTitle: "Eventing-contrib API"
|
||||||
weight: 50
|
weight: 50
|
||||||
type: "docs"
|
type: "docs"
|
||||||
|
aliases:
|
||||||
|
- /docs/reference/eventing/eventing-contrib-api
|
||||||
---
|
---
|
||||||
|
|
||||||
{{< readfile file="eventing-contrib.md" >}}
|
{{< readfile file="eventing-contrib.md" >}}
|
|
@ -1,8 +1,10 @@
|
||||||
---
|
---
|
||||||
title: "Knative Serving Component"
|
title: "Knative Serving Component"
|
||||||
linkTitle: "Serving API"
|
linkTitle: "Serving API"
|
||||||
weight: 50
|
weight: 10
|
||||||
type: "docs"
|
type: "docs"
|
||||||
|
aliases:
|
||||||
|
- /docs/reference/serving-api
|
||||||
---
|
---
|
||||||
|
|
||||||
{{< readfile file="serving.md" >}}
|
{{< readfile file="serving.md" >}}
|
|
@ -1 +0,0 @@
|
||||||
Knative Client, `kn`, is a command line interface (CLI) for creating and managing Knative applications from the terminal.
|
|
|
@ -1,8 +0,0 @@
|
||||||
---
|
|
||||||
title: "Client (Kn)"
|
|
||||||
linkTitle: "Client (Kn)"
|
|
||||||
weight: 10
|
|
||||||
type: "docs"
|
|
||||||
---
|
|
||||||
|
|
||||||
{{% readfile file="README.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)
|
|
@ -1,7 +1,9 @@
|
||||||
---
|
---
|
||||||
title: "Resources"
|
title: "Additional resources"
|
||||||
weight: 10
|
weight: 100
|
||||||
type: "docs"
|
type: "docs"
|
||||||
|
aliases:
|
||||||
|
- /docs/concepts/resources
|
||||||
---
|
---
|
||||||
|
|
||||||
This page contains information about various tools and technologies that are
|
This page contains information about various tools and technologies that are
|
Loading…
Reference in New Issue