summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-05-08 12:57:10 +0200
committerGitHub <noreply@github.com>2020-05-08 12:57:10 +0200
commit70e7fc670be13d3877e65e160456c312e23a5806 (patch)
tree29a281cc4038ea661256dc3d5b199917a93c16a8
parentcc6a77cc88bb997080f773d93d420025ce92da1d (diff)
parent50cb32fdfb1e382f14e985236d33e69a2912e5ed (diff)
downloadpodman-70e7fc670be13d3877e65e160456c312e23a5806.tar.gz
podman-70e7fc670be13d3877e65e160456c312e23a5806.tar.bz2
podman-70e7fc670be13d3877e65e160456c312e23a5806.zip
Merge pull request #6054 from cevich/swagger_docs_task_cors
CI:DOCS: Document API docs + CORS maintenance
-rw-r--r--contrib/cirrus/README.md42
-rw-r--r--docs/Readme.md11
2 files changed, 39 insertions, 14 deletions
diff --git a/contrib/cirrus/README.md b/contrib/cirrus/README.md
index 709985b5b..541cf2f54 100644
--- a/contrib/cirrus/README.md
+++ b/contrib/cirrus/README.md
@@ -165,20 +165,34 @@ env:
* Choose the *test_build_cache_images* task.
* Open the *build_vm_images* script section.
-### `release` Task
-
-Gathers up zip files uploaded by other tasks, from the local Cirrus-CI caching service.
-Depending on the execution context (a PR or a branch), this task uploads the files
-found to storage buckets at:
-
-* [https://storage.cloud.google.com/libpod-pr-releases](https://storage.cloud.google.com/libpod-pr-releases)
-* [https://storage.cloud.google.com/libpod-master-releases](https://storage.cloud.google.com/libpod-master-releases)
-
-***Note:*** Repeated builds from the same PR or branch, will clobber previous archives
- *by design*. This is intended so that the "latest" archive is always
- available at a consistent URL. The precise details regarding a particular
- build is encoded within the zip-archive comment.
-
+### `docs` Task
+
+Builds swagger API documentation YAML and uploads to google storage for both
+PR's (for testing the process) and after a merge into any branch. For PR's
+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.
+
+***Note***: [The online documentation](http://docs.podman.io/en/latest/_static/api.html)
+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
+[Configuring CORS on a bucket](https://cloud.google.com/storage/docs/configuring-cors#configure-cors-bucket)
+for details. This may be performed by anybody with admin access to the google storage bucket,
+using the following JSON:
+
+```JSON
+[
+ {
+ "origin": ["http://docs.podman.io"],
+ "responseHeader": ["Content-Type"],
+ "method": ["GET"],
+ "maxAgeSeconds": 600
+ }
+]
+```
## Base-images
diff --git a/docs/Readme.md b/docs/Readme.md
index 209dcd6b4..4d10cfa56 100644
--- a/docs/Readme.md
+++ b/docs/Readme.md
@@ -26,3 +26,14 @@ link on that page.
| ------------------------------------ | --------------------------- |
| 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 |
+
+## 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.