8000 API docs for 0.18 docs release by RichieEscarez · Pull Request #2867 · knative/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

API docs for 0.18 docs release #2867

New issue 8000

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 30, 2020
Merged

API docs for 0.18 docs release #2867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d0f9e7e
API build for 0.18 serving and eventing
RichieEscarez Sep 29, 2020
c9adcfe
fix for ref docs restructure
RichieEscarez Sep 29, 2020
73a62ee
add eventing-contrib and auto trim whitespace
RichieEscarez Sep 30, 2020
aac057f
manually remove whitespace and add that to the instructions
RichieEscarez Sep 30, 2020
5272bca
fix nav ordering
RichieEscarez Sep 30, 2020
281fc1f
remove whitespace
RichieEscarez Sep 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions docs/reference/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,26 +85,28 @@ To generate a version of the API:
1. Copy the generated API files into the `docs/reference` directory of your
knative/docs clone.

1. The linter now fails for content with trailing whitespaces. Use a tool of your choice to
remove all trailing whitespace. For example, search for and remove: `\s+$`

You can now perform the necessary steps to open a PR, complete a review, and
merge the new API files into the appropriate branch of the `knative/docs` repo.
See the [contributor flow](https://github.com/knative/community/blob/master/docs/DOCS-CONTRIBUTING.md) for details
about requesting changes in the `knative/docs` repo.

### 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.18, you can use the `v0.18.0` the tags
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
use a commit for Serving v0.3.0, you would use
[4d198d](https://github.com/knative/serving/commit/4d198db8756db2f8a3c228302a97fb3a216a9475).
[Serving v0.18.0](https://github.com/knative/serving/tree/v0.18.0). If you want to
use a commit for Serving v0.18.0, you would use
[850b7c](https://github.com/knative/serving/commit/850b7cca7d7701b052420a030f2308d19938d45e).

Using tags from each repo, you would run the following command to generate the
v0.3.0 API source files:
v0.18.0 API source files:

```
KNATIVE_SERVING_COMMIT=v0.3.0 \
KNATIVE_EVENTING_COMMIT=v0.3.0 \
KNATIVE_EVENTING_CONTRIB_COMMIT=v0.3.0 \
KNATIVE_SERVING_COMMIT=v0.18.0 \
KNATIVE_EVENTING_COMMIT=v0.18.0 \
KNATIVE_EVENTING_CONTRIB_COMMIT=v0.18.0 \
./gen-api-reference-docs.sh
```
7 changes: 1 addition & 6 deletions docs/reference/api/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
---
title: "Knative API Reference Documentation"
linkTitle: "API"
weight: 100
weight: 50
type: "docs"
aliases:
aliases:
- /docs/reference/
---

{{% readfile file="README.md" %}}
Loading
0