diff options
| author | Scott McCarty <scott.mccarty@gmail.com> | 2020-05-20 16:30:32 -0400 |
|---|---|---|
| committer | Scott McCarty <scott.mccarty@gmail.com> | 2020-05-21 17:16:10 -0400 |
| commit | 176f38c25b3c1419decac36cf078f75a6e6a49e2 (patch) | |
| tree | 06881142f865fe6516e637fbc0f92688824b3ec5 /docs/source/index.rst | |
| parent | 6a75dfa8a85d7b9677f545aba976dbe82404cf3d (diff) | |
| download | podman-176f38c25b3c1419decac36cf078f75a6e6a49e2.tar.gz podman-176f38c25b3c1419decac36cf078f75a6e6a49e2.tar.bz2 podman-176f38c25b3c1419decac36cf078f75a6e6a49e2.zip | |
[CI:DOCS] Docs revamp.
* Rewrote the Home and Introduction pages.
* Created a dedicated Search page
* Rewrote the Tutorials page to have native links in RTD/Shpinx
* Added iframe to Reference page to display API reference docs inline
Signed-off-by: Scott McCarty <scott.mccarty@gmail.com>
Diffstat (limited to 'docs/source/index.rst')
| -rw-r--r-- | docs/source/index.rst | 25 |
1 files changed, 10 insertions, 15 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index 9dd61a6a6..9cc8e7af8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,10 +1,14 @@ -.. Podman documentation master file, created by - sphinx-quickstart on Tue Oct 22 15:20:30 2019. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. include:: includes.rst -Welcome to Podman's documentation! +What is Podman? ================================== +Podman_ is a daemonless, open source, Linux native tool designed to make it easy to find, run, build, share and deploy applications using Open Containers Initiative (OCI_) Containers_ and `Container Images`_. Podman provides a command line interface (CLI) familiar to anyone who has used the Docker `Container Engine`_. Most users can simply alias Docker to Podman (`alias docker=podman`) without any problems. Similiar other common `Container Engines`_ (Docker, CRI-O, containerd), Podman relies on an OCI compliant `Container Runtime`_ (runc, crun, runv, etc) to interface with the operating system and create the running containers.This makes the running containers created by Podman nearly indistinguishable from those created by any other common container engine. + +Containers under the control of Podman can either be run by root or by a non-privileged user. Podman manages the entire container ecosystem which includes pods, containers, container images, and container volumes using the libpod_ library. Podman specializes in all of the commands and functions that help you to maintain and modify OCI container images, such as pulling and tagging. It allows you to create, run, and maintain those containers and container images in a production environment. + +The Podman service runs only on Linux platforms, however a REST API and clients are currently under development which will allow Mac and Windows platforms to call the service. There is currently a Varlink based remote client which runs on Mac or Windows platforms that allows the remote client to talk to the Podman server on a Linux platform. In addition to those clients, there is also a Mac client. NOTE: the Varlink remote client will be deprecated after the REST API is completed. + +If you are completely new to containers, we recommend that you check out the :doc:`Introduction`. For power users or those comming from Docker, check out our :doc:`Tutorials`. For advanced users and contributors, you can get very detailed information about the Podman CLI by looking our :doc:`Commands` page. Finally, for Developers looking at how to interact with the Podman API, please see our API documentation :doc:`Reference`. .. toctree:: :maxdepth: 2 @@ -14,13 +18,4 @@ Welcome to Podman's documentation! Commands Reference Tutorials - - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + Search |