Skip to content

Commit

Permalink
Add stronger user orientation to docs
Browse files Browse the repository at this point in the history
fixes #8946
  • Loading branch information
Melanie Corr committed Jun 28, 2021
1 parent 21494e1 commit 4ad3cf3
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 20 deletions.
1 change: 1 addition & 0 deletions CHANGES/8946.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updated the docs.pulpproject.org to provide some immediate direction for better user orientation.
42 changes: 22 additions & 20 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,28 @@
Pulp Documentation
==================

This documentation is for `pulpcore`, which is used with plugins to fetch, upload, and organize
arbitrary content types.
This is the main landing page for documentation related to Pulp.

The documentation itself is broken into sub categories that provide more granular information and
workflows.

`pulpcore` handles some parts of common content management workflows, including high performance
downloading, task queuing with scalable workers, and management of content within versioned
repositories.

If you are looking for a very high-level overview of Pulp's features, check out `features page at
pulpproject.org <https://pulpproject.org/features/>`_

If you want an overview of the main concepts and terminology of Pulp, see :doc:`general concepts and
terminology<concepts>`

If you want to understand the core workflows, see :ref:`Workflows`

If you want to look at the considerations and requirements for installing Pulp, see
:ref:`installation`. If you want to evaluate Pulp quickly, try `Pulp in One
Container <https://pulpproject.org/pulp-in-one-container/>`_

If you're looking for documentation specific to a content type, see :ref:`List of Plugins`

Anyone interested in writing a plugin should reference the :ref:`Plugin API`.

Expand Down Expand Up @@ -36,24 +56,6 @@ Source code
* `plugin repositories <https://pulpproject.org/content-plugins/>`_


How to Navigate the pulpcore and plugin docs
--------------------------------------------

Plugin Documentation
^^^^^^^^^^^^^^^^^^^^

If you are a new user who is evaluating Pulp it is recommended that you skim the documentation for
the plugins that add the content types you are interested in. Links to these docs can be found in
our `list of plugins <https://docs.pulpproject.org/pulpcore/plugins/index.html#plugins>`_

Pulpcore Documentation
^^^^^^^^^^^^^^^^^^^^^^

`pulpcore` handles some parts of common content management workflows, including high performance
downloading, task queuing with scalable workers, and management of content within versioned
repositories. Information about :ref:`installation`, :ref:`deployment`, and :doc:`general concepts
and terminology<concepts>` are all covered by the ``pulpcore`` documentation.


Table of Contents
-----------------
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Plugins
=======

.. _List of Plugins:

Plugins add support for a type of content to Pulp. For example, the
`file_plugin <https://github.com/pulp/pulp_file>`_ adds support for Pulp to manage files.

Expand Down
2 changes: 2 additions & 0 deletions docs/workflows/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Workflows and Use Cases
=======================

.. _Workflows:

Best practices for content management are discussed here. The goal of this document is to provide a
framework for users to design their own workflows with any content type. For specific examples,
users should refer to `plugin documentation <https://pulpproject.org/content-plugins/>`_. This page
Expand Down

0 comments on commit 4ad3cf3

Please sign in to comment.