From c2a4e0105c9a69354e0fb2edf9c5f9403ea4d5c3 Mon Sep 17 00:00:00 2001 From: TomSweeneyRedHat Date: Mon, 4 Nov 2019 18:22:32 -0500 Subject: 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 --- docs/Readme.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'docs/Readme.md') 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 | -- cgit v1.2.3-54-g00ecf