diff options
| author | Chris Evich <cevich@redhat.com> | 2020-04-30 12:56:43 -0400 |
|---|---|---|
| committer | Chris Evich <cevich@redhat.com> | 2020-05-06 15:52:53 -0400 |
| commit | 50cb32fdfb1e382f14e985236d33e69a2912e5ed (patch) | |
| tree | 8f1cef58caa698fde79938ede7ab42d1e932b98c /docs/Readme.md | |
| parent | 01aad516e012fe46179e053addd7a8a84788228b (diff) | |
| download | podman-50cb32fdfb1e382f14e985236d33e69a2912e5ed.tar.gz podman-50cb32fdfb1e382f14e985236d33e69a2912e5ed.tar.bz2 podman-50cb32fdfb1e382f14e985236d33e69a2912e5ed.zip | |
CI:DOCS: Document API docs + CORS maintenance
Signed-off-by: Chris Evich <cevich@redhat.com>
Diffstat (limited to 'docs/Readme.md')
| -rw-r--r-- | docs/Readme.md | 11 |
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. |