Skip to content

Commit 1397e22

Browse files
RichieEscarezknative-prow-robot
authored andcommitted
eventing-contrib API and consistent file names (#1805)
1 parent ecade3b commit 1397e22

File tree

6 files changed

+218
-5095
lines changed

6 files changed

+218
-5095
lines changed

docs/reference/README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The API source files are located at:
1111

1212
- [Serving API](./serving.md)
1313
- [Eventing API](./eventing/eventing.md)
14-
- [Eventing-contrib resources API](./eventing/eventing-resources.md)
14+
- [Eventing-contrib resources API](./eventing/eventing-contrib.md)
1515

1616
## Updating API Reference docs (for Knative maintainers)
1717

@@ -57,18 +57,20 @@ To generate a version of the API:
5757
1. Locate the commits or tags that correspond to the version of the API that you
5858
want to generate:
5959

60+
- [Serving](https://github.com/knative/serving/releases/)
6061
- [Eventing](https://github.com/knative/eventing/releases/)
6162
- [Eventing-contrib resources](https://github.com/knative/eventing-contrib/releases/)
62-
- [Serving](https://github.com/knative/serving/releases/)
6363

6464
1. To run the `gen-api-reference-docs.sh` command from the `hack` directory, you
6565
specify the commits or tags for each of the corresponding Knative component
6666
variables (`KNATIVE_[component_name]_COMMIT`):
6767

6868
```
69-
KNATIVE_EVENTING_COMMIT=[commit_or_tag] \
70-
KNATIVE_EVENTING_SOURCES_COMMIT=[commit_or_tag] \
69+
cd hack
70+
7171
KNATIVE_SERVING_COMMIT=[commit_or_tag] \
72+
KNATIVE_EVENTING_COMMIT=[commit_or_tag] \
73+
KNATIVE_EVENTING_CONTRIB_COMMIT=[commit_or_tag] \
7274
./gen-api-reference-docs.sh
7375
```
7476

@@ -85,12 +87,6 @@ To generate a version of the API:
8587
1. Copy the generated API files into the `docs/reference` directory of your
8688
knative/docs clone.
8789

88-
1. IMPORTANT: There are some limitations to the build script that require manual
89-
changes to the HTML. For the `serving.md` and
90-
`eventing-contrib-resources.md`, you must manually fix the `Packages` lists.
91-
Details for the required manual changes are in
92-
[PR 1552](https://github.com/knative/docs/pull/1552#issuecomment-506891983).
93-
9490
You can now perform the necessary steps to open a PR, complete a review, and
9591
merge the new API files into the appropriate branch of the `knative/docs` repo.
9692
See the [contributor flow](../../contributing/DOCS-CONTRIBUTING.md) for details
@@ -108,8 +104,8 @@ Using tags from each repo, you would run the following command to generate the
108104
v0.3.0 API source files:
109105

110106
```
111-
KNATIVE_EVENTING_COMMIT=v0.3.0 \
112-
KNATIVE_EVENTING_SOURCES_COMMIT=v0.3.0 \
113107
KNATIVE_SERVING_COMMIT=v0.3.0 \
108+
KNATIVE_EVENTING_COMMIT=v0.3.0 \
109+
KNATIVE_EVENTING_CONTRIB_COMMIT=v0.3.0 \
114110
./gen-api-reference-docs.sh
115111
```

docs/reference/eventing/eventing-contrib-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ weight: 50
55
type: "docs"
66
---
77

8-
{{< readfile file="eventing-contrib-resources.md" relative="true" >}}
8+
{{< readfile file="eventing-contrib.md" relative="true" >}}

0 commit comments

Comments
 (0)