2015-07-16 02:46:04 +00:00
|
|
|
This folder contains the sources needed to build the gen-swagger-doc container.
|
|
|
|
|
|
|
|
|
|
To build the container image,
|
|
|
|
|
|
|
|
|
|
```
|
Switch to k8s.gcr.io vanity domain
This is the 2nd attempt. The previous was reverted while we figured out
the regional mirrors (oops).
New plan: k8s.gcr.io is a read-only facade that auto-detects your source
region (us, eu, or asia for now) and pulls from the closest. To publish
an image, push k8s-staging.gcr.io and it will be synced to the regionals
automatically (similar to today). For now the staging is an alias to
gcr.io/google_containers (the legacy URL).
When we move off of google-owned projects (working on it), then we just
do a one-time sync, and change the google-internal config, and nobody
outside should notice.
We can, in parallel, change the auto-sync into a manual sync - send a PR
to "promote" something from staging, and a bot activates it. Nice and
visible, easy to keep track of.
2018-01-17 19:36:53 +00:00
|
|
|
$ sudo docker build -t k8s.gcr.io/gen-swagger-docs:v1 .
|
2015-07-16 02:46:04 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To generate the html docs,
|
|
|
|
|
|
|
|
|
|
```
|
2017-06-09 06:25:32 +00:00
|
|
|
$ ./gen-swagger-docs.sh <API version> <absolute output path, default to PWD>
|
2015-07-16 02:46:04 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The generated definitions.html and operations.html will be stored in output paths.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[]()
|
