diff options
author | TomSweeneyRedHat <tsweeney@redhat.com> | 2019-11-04 18:22:32 -0500 |
---|---|---|
committer | TomSweeneyRedHat <tsweeney@redhat.com> | 2019-11-04 18:22:41 -0500 |
commit | c2a4e0105c9a69354e0fb2edf9c5f9403ea4d5c3 (patch) | |
tree | 943fd9fc4ebe1dc8e2ed3e06cd9229d5a223421f /docs | |
parent | 17eadda68b868ab1dc8c455f4f537b78ad3962a5 (diff) | |
download | podman-c2a4e0105c9a69354e0fb2edf9c5f9403ea4d5c3.tar.gz podman-c2a4e0105c9a69354e0fb2edf9c5f9403ea4d5c3.tar.bz2 podman-c2a4e0105c9a69354e0fb2edf9c5f9403ea4d5c3.zip |
Add links to readthedocs on docs/readme
Add a couple of links to the new ReadTheDocs site
for the libpod man pages from the docs/readme.md. Many users
go to github.com/{project}/docs looking for the man pages for
the project and their location is not evident on the current
readme.md.
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Readme.md | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/Readme.md b/docs/Readme.md index 4514afa77..209dcd6b4 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -1,3 +1,10 @@ +# Podman Documentation + +The online man pages and other documents regarding Podman can be found at +[Read The Docs](https://podman.readthedocs.io/en/latest/index.html). 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 @@ -18,4 +25,4 @@ | | | | ------------------------------------ | --------------------------- | | 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 |
\ No newline at end of file +| docs/links-to-html.lua | pandoc filter to do aliases for html files | |