opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-11 10:25:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6054 from cevich/swagger_docs_task_cors

Browse Source 
CI:DOCS: Document API docs + CORS maintenance
This commit is contained in:
OpenShift Merge Robot
2020-05-08 12:57:10 +02:00
committed by GitHub
parent cc6a77cc88 50cb32fdfb
commit 70e7fc670b
2 changed files with 36 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
contrib/cirrus/README.md
View File

@ -165,20 +165,34 @@ env:
* Choose the *test_build_cache_images* task. * Choose the *test_build_cache_images* task.
* Open the *build_vm_images* script section. * Open the *build_vm_images* script section.
### `release` Task ### `docs` Task
Gathers up zip files uploaded by other tasks, from the local Cirrus-CI caching service. Builds swagger API documentation YAML and uploads to google storage for both
Depending on the execution context (a PR or a branch), this task uploads the files PR's (for testing the process) and after a merge into any branch. For PR's
found to storage buckets at: the YAML is uploaded into a [dedicated short-pruning cycle
bucket.](https://storage.googleapis.com/libpod-pr-releases/) For branches,
a [separate bucket is
used.](https://storage.googleapis.com/libpod-master-releases)
In both cases the filename includes the source
PR number or branch name.
* [https://storage.cloud.google.com/libpod-pr-releases](https://storage.cloud.google.com/libpod-pr-releases) ***Note***: [The online documentation](http://docs.podman.io/en/latest/_static/api.html)
* [https://storage.cloud.google.com/libpod-master-releases](https://storage.cloud.google.com/libpod-master-releases) is presented through javascript on the client-side. This requires CORS to be properly
configured on the bucket, for the `http://docs.podman.io` origin. Please see
***Note:*** Repeated builds from the same PR or branch, will clobber previous archives [Configuring CORS on a bucket](https://cloud.google.com/storage/docs/configuring-cors#configure-cors-bucket)
*by design*. This is intended so that the "latest" archive is always for details. This may be performed by anybody with admin access to the google storage bucket,
available at a consistent URL. The precise details regarding a particular using the following JSON:
build is encoded within the zip-archive comment.
```JSON
[
{
"origin": ["http://docs.podman.io"],
"responseHeader": ["Content-Type"],
"method": ["GET"],
"maxAgeSeconds": 600
}
]
```
## Base-images ## Base-images

11
docs/Readme.md
View File

@ -26,3 +26,14 @@ link on that page.
| ------------------------------------ | --------------------------- | | ------------------------------------ | --------------------------- |
| docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform | | docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform |
| docs/links-to-html.lua | pandoc filter to do aliases for html files | | docs/links-to-html.lua | pandoc filter to do aliases for html files |
## API Reference
The [latest online documentation](http://docs.podman.io/en/latest/_static/api.html) is
automatically generated from committed upstream sources. There is a short-duration
cache involved, in case old content or an error is returned, try clearing your browser
cache or returning to the site after 10-30 minutes.
***Maintainers Note***: Please refer to [the Cirrus-CI tasks
documentation](../contrib/cirrus/README.md#docs-task) for
important operational details.