Skip to content

Commit

Permalink
Move overview articles to high level
Browse files Browse the repository at this point in the history
As "Overview" page is just an index of other pages
which should belong to top level of docs, moving
"Concepts and Terminology", "Changes from Pulp 2"
and "Architecture and Scaling" pages to the top
level of the menu and removing "Overview" section.

closes #4099

https://pulp.plan.io/issues/4099

Signed-off-by: Pavel Picka <ppicka@redhat.com>
  • Loading branch information
pavelpicka committed Nov 19, 2018
1 parent 8472d2d commit 6fc5e84
Show file tree
Hide file tree
Showing 9 changed files with 7 additions and 13 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/contributing/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Pulp's documentation is designed with the following principles:
#. The structure should present introductory material before advanced topics.
#. Documentation should cross reference to limit repitition.
#. Pulp terminology should be be explicitly defined and added to the glossary.
#. Documentation should stay consistent with the language used in the :doc:`/overview/concepts`.
#. Documentation should stay consistent with the language used in the :doc:`/concepts`.
#. Where reasonable, documents should include:

#. Summary of content.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Contributing
============

Contribution documentation generally assumes that the reader is familiar with
:doc:`Pulp basics</overview/index>`. If you have problems, you can :ref:`contact us<community>`
:doc:`Pulp basics</concepts>`. If you have problems, you can :ref:`contact us<community>`
or :doc:`file an issue</bugs-features>`.

Fundamentals
Expand Down
File renamed without changes.
6 changes: 4 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ content type is provided by the corresponding plugin, which can be found in our
Self-Guided Tour for New Users
------------------------------

A good place for new users to start is the :doc:`overview/index`, which gives a high level
A good place for new users to start is the :doc:`concepts`, which gives a high level
introduction to Pulp concepts, terminology, and components. After :doc:`installing
pulp<installation/index>`, the simplest way to get concrete experience is to install one of the
:ref:`plugins<plugin-table>` and use its quickstart guide. Next it is recommended that users read
Expand Down Expand Up @@ -51,7 +51,9 @@ Table of Contents
.. toctree::
:maxdepth: 2

overview/index
concepts
from-pulp-2
components/index
installation/index
plugins/index
workflows/index
Expand Down
8 changes: 0 additions & 8 deletions docs/overview/index.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/workflows/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Workflows and Use Cases
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 :ref:`plugin<plugin-table>` documentation. This page assumes that the reader
is familiar with the fundamentals discussed in the :doc:`/overview/index`.
is familiar with the fundamentals discussed in the :doc:`/concepts`.


.. toctree::
Expand Down

0 comments on commit 6fc5e84

Please sign in to comment.