summaryrefslogtreecommitdiff
path: root/docs/Readme.md
diff options
context:
space:
mode:
authorTomSweeneyRedHat <tsweeney@redhat.com>2021-03-29 17:52:15 -0400
committerTomSweeneyRedHat <tsweeney@redhat.com>2021-03-30 18:45:40 -0400
commit09f2c01ded216c9d7fa6b976f2af98bde474e99a (patch)
treef0e089312f65e27790c6218bcbae068501f0be58 /docs/Readme.md
parenta373e2fdf38456b8ac584809e73cdb9f9521a796 (diff)
downloadpodman-09f2c01ded216c9d7fa6b976f2af98bde474e99a.tar.gz
podman-09f2c01ded216c9d7fa6b976f2af98bde474e99a.tar.bz2
podman-09f2c01ded216c9d7fa6b976f2af98bde474e99a.zip
[CI:DOCS] Add local html build info to docs/README.md
Rename Readme.md to README.md in the docs directory. Add the local build process per @Luap99 in #9856 for the man pages to preview any changes that are made. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Diffstat (limited to 'docs/Readme.md')
-rw-r--r--docs/Readme.md54
1 files changed, 0 insertions, 54 deletions
diff --git a/docs/Readme.md b/docs/Readme.md
deleted file mode 100644
index e0918cd54..000000000
--- a/docs/Readme.md
+++ /dev/null
@@ -1,54 +0,0 @@
-# Podman Documentation
-
-The online man pages and other documents regarding Podman can be found at
-[Read The Docs](https://podman.readthedocs.io). The man pages
-can be found under the [Commands](https://podman.readthedocs.io/en/latest/Commands.html)
-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](http://docs.podman.io/en/latest/_static/api.html) is
-automatically generated by two cooperating automation systems based on committed upstream
-source code. Firstly, [the Cirrus-CI docs task](../contrib/cirrus/README.md#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](readthedocs.com)
-reacts to the github.com repository change, building the content for the [libpod documentation
-site](https://podman.readthedocs.io/). 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](../contrib/cirrus/swagger_stack_trace.png)
-
-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](https://github.com/containers/podman#communications)
-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.