@@ -85,26 +85,28 @@ To generate a version of the API:
85
85
1 . Copy the generated API files into the ` docs/reference ` directory of your
86
86
knative/docs clone.
87
87
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
+
88
91
You can now perform the necessary steps to open a PR, complete a review, and
89
92
merge the new API files into the appropriate branch of the ` knative/docs ` repo.
90
93
See the [ contributor flow] ( https://github.com/knative/community/blob/master/docs/DOCS-CONTRIBUTING.md ) for details
91
94
about requesting changes in the ` knative/docs ` repo.
92
95
93
96
### Example
94
97
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
97
99
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 ) .
101
103
102
104
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:
104
106
105
107
```
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 \
109
111
./gen-api-reference-docs.sh
110
112
```
0 commit comments