@@ -85,26 +85,28 @@ To generate a version of the API:
85851 . 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+
8891You can now perform the necessary steps to open a PR, complete a review, and
8992merge the new API files into the appropriate branch of the ` knative/docs ` repo.
9093See the [ contributor flow] ( https://github.com/knative/community/blob/master/docs/DOCS-CONTRIBUTING.md ) for details
9194about 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
9799from 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
102104Using 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```
0 commit comments