Skip to content

Commit ff5c179

Browse files
authored
Merge pull request #241 from asmacdo/cleanup-core-division
Cleanup index to be consistent with pulpcore
2 parents 72f496d + 3a7aa9f commit ff5c179

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/index.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,24 @@ pulp-python Plugin
22
==================
33

44
The ``pulp_python`` plugin extends `pulpcore <https://pypi.python.org/pypi/pulpcore/>`_ to support
5-
hosting pip compatible Python packages similarly to the `Python Package Index
6-
<https://pypi.org/>`_.
5+
hosting pip compatible Python packages like the `Python Package Index <https://pypi.org/>`_.
76

87
How to use these docs
98
---------------------
109

1110
The documentation here should be considered **the primary documentation for managing Python
12-
content**. All relevent workflows are covered here, with references to some pulpcore supplemental
13-
docs. Users may also find `pulpcore's conceptual docs
14-
<https://docs.pulpproject.org/en/3.0/nightly/concepts.html>`_ useful. Here, the documentation falls
15-
into two main categories:
11+
content**. See `How to navigate the pulpcore and plugin docs
12+
<https://docs.pulpproject.org/en/3.0/nightly/index.html#how-to-navigate-the-pulpcore-and-plugin-docs>`_
13+
for a more thorough explanation.
14+
15+
All relevent workflows are covered here, with references to pulpcore supplemental docs. Users may
16+
also find `pulpcore's conceptual docs <https://docs.pulpproject.org/en/3.0/nightly/concepts.html>`_
17+
helpful. Here, the documentation falls into two main categories:
1618

1719
1. :ref:`workflows-index` show the **major features** of the Python plugin, with links to reference
1820
docs.
19-
2. `REST API Docs <restapi.html>`_ are automatically generated and provide more detailed
20-
information for each **minor feature**, including all fields and options.
21+
2. `REST API Docs <restapi.html>`_ are automatically generated and are responsible for containing
22+
thorough information for each **minor feature**, including all fields and options.
2123

2224
Community
2325
---------
@@ -29,7 +31,7 @@ Also, contributions are greatly appreciated in the form of:
2931
2. `Github Pull Requests <https://github.com/pulp/pulp_python>`_
3032
3. `Helping other users <https://docs.pulpproject.org/en/3.0/nightly/#community>`_
3133

32-
We can usually be found on freenode in `pulp-dev`, `pulp`, and `pulp-python`.
34+
We can usually be found on freenode in `#pulp-dev`, `#pulp`, and `#pulp-python`.
3335

3436
Table of Contents
3537
-----------------

0 commit comments

Comments
 (0)