container/podman
container/podman
1
0
Fork 0
mirror of https://github.com/containers/podman synced 2024-10-19 08:44:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
podman/docs
History
Paul Holzinger 80b613d237 Fix markdown tables on docs.podman.io 
Sphinx with recommonmark cannot render markdown tables at all.
There is a python package called `sphinx-markdown-tables` which
adds the markdown table support to recommonmark.
https://pypi.org/project/sphinx-markdown-tables/

By utilising this package we don't have to change our doc format.

Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
2020-11-13 16:42:13 +01:00
..
source Fix markdown tables on docs.podman.io 2020-11-13 16:42:13 +01:00
tutorials Add missing --now in systemctl start command 2020-11-12 19:18:59 -07:00
varlink make lint: include docs/ 2020-01-14 09:54:48 +01:00
dckrman.sh Fix docker man page links 2020-03-19 14:03:02 -04:00
generate.go V2 Move varlink home 2020-03-30 08:18:35 -07:00
links-to-html.lua Update XML to not embed quote in PATH on windows 2020-01-31 15:22:20 -07:00
make.bat Restructure documentation dir 2019-10-31 12:31:39 -05:00
Makefile Restructure documentation dir 2019-10-31 12:31:39 -05:00
play.png Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
podman-derivative-api systemd: expect full path /usr/sbin/init 2019-10-09 23:38:45 +02:00
Readme.md Fix issues found with codespell 2020-11-12 13:37:38 -05:00
remote-docs.sh Switch use of Flags to Options 2020-10-21 08:37:57 -04:00
requirements.txt Fix markdown tables on docs.podman.io 2020-11-13 16:42:13 +01:00

Readme.md

Podman Documentation

The online man pages and other documents regarding Podman can be found at Read The Docs. The man pages can be found under the Commands link on that page.

Build the Docs

Directory Structure

Directory
Markdown source for man pages docs/source/markdown/
man pages aliases as .so files docs/source/markdown/links/
restructured text for readthedocs.io docs/rst/
target for output docs/build
man pages docs/build/man
remote linux man pages docs/build/remote/linux
remote darwin man pages docs/build/remote/darwin
remote windows html pages docs/build/remote/windows

Support files
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 is automatically generated by two cooperating automation systems based on committed upstream source code. Firstly, the Cirrus-CI docs task builds pkg/api/swagger.yaml and uploads it to a public-facing location (Google Storage Bucket - an online service for storing unstructured data). Second, Read The Docs reacts to the github.com repository change, building the content for the libpod documentation site. This site includes for the API section, some javascript which consumes the uploaded swagger.yaml file directly from the Google Storage Bucket.

Since there are multiple systems and local cache is involved, it's possible that updates to documentation (especially the swagger/API docs) will lag by 10-or-so minutes. However, because the client (i.e. your web browser) is fetching content from multiple locations that do not share a common domain, accessing the API section may show a stack-trace similar to the following:

Javascript Stack Trace Image

If reloading the page, or clearing your local cache does not fix the problem, it is likely caused by broken metadata needed to protect clients from cross-site-scripting style attacks. Please notify a maintainer so they may investigate how/why the swagger.yaml file's CORS-metadata is incorrect, or the file isn't accessible for some other reason.