Skip to content

Commit cf4781e

Browse files
API docs for 0.18 docs release (#2867)
* API build for 0.18 serving and eventing * fix for ref docs restructure * add eventing-contrib and auto trim whitespace * manually remove whitespace and add that to the instructions * fix nav ordering * remove whitespace
1 parent 928470b commit cf4781e

File tree

6 files changed

+4957
-7611
lines changed

6 files changed

+4957
-7611
lines changed

docs/reference/api/README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -85,26 +85,28 @@ To generate a version of the API:
8585
1. Copy the generated API files into the `docs/reference` directory of your
8686
knative/docs clone.
8787

88+
1. The linter now fails for content with trailing whitespaces. Use a tool of your choice to
89+
remove all trailing whitespace. For example, search for and remove: `\s+$`
90+
8891
You can now perform the necessary steps to open a PR, complete a review, and
8992
merge the new API files into the appropriate branch of the `knative/docs` repo.
9093
See the [contributor flow](https://github.com/knative/community/blob/master/docs/DOCS-CONTRIBUTING.md) for details
9194
about requesting changes in the `knative/docs` repo.
9295

9396
### Example
9497

95-
<!--TODO: UPDATE THIS EXAMPLE VERSION-->
96-
To build a set of Knative API docs for v0.3, you can use the `v0.3.0` the tags
98+
To build a set of Knative API docs for v0.18, you can use the `v0.18.0` the tags
9799
from each of the Knative component repositories, like
98-
[Serving v0.3.0](https://github.com/knative/serving/tree/v0.3.0). If you want to
99-
use a commit for Serving v0.3.0, you would use
100-
[4d198d](https://github.com/knative/serving/commit/4d198db8756db2f8a3c228302a97fb3a216a9475).
100+
[Serving v0.18.0](https://github.com/knative/serving/tree/v0.18.0). If you want to
101+
use a commit for Serving v0.18.0, you would use
102+
[850b7c](https://github.com/knative/serving/commit/850b7cca7d7701b052420a030f2308d19938d45e).
101103

102104
Using tags from each repo, you would run the following command to generate the
103-
v0.3.0 API source files:
105+
v0.18.0 API source files:
104106

105107
```
106-
KNATIVE_SERVING_COMMIT=v0.3.0 \
107-
KNATIVE_EVENTING_COMMIT=v0.3.0 \
108-
KNATIVE_EVENTING_CONTRIB_COMMIT=v0.3.0 \
108+
KNATIVE_SERVING_COMMIT=v0.18.0 \
109+
KNATIVE_EVENTING_COMMIT=v0.18.0 \
110+
KNATIVE_EVENTING_CONTRIB_COMMIT=v0.18.0 \
109111
./gen-api-reference-docs.sh
110112
```

docs/reference/api/_index.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
---
22
title: "Knative API Reference Documentation"
33
linkTitle: "API"
4-
weight: 100
4+
weight: 50
55
type: "docs"
6-
aliases:
7-
aliases:
8-
- /docs/reference/
96
---
10-
11-
{{% readfile file="README.md" %}}

0 commit comments

Comments
 (0)