summaryrefslogtreecommitdiff
path: root/docs
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 /docs
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
Diffstat (limited to 'docs')
-rw-r--r--docs/Readme.md11
1 files changed, 11 insertions, 0 deletions
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.