Skip to content
This repository has been archived by the owner on Dec 7, 2022. It is now read-only.

Dev setup docs refactor #3051

Merged
merged 1 commit into from Jun 21, 2017
Merged

Conversation

asmacdo
Copy link
Contributor

@asmacdo asmacdo commented Jun 9, 2017

Docs for dev setup changes: pulp/devel#56

@asmacdo asmacdo changed the title WIP Dev setup docs refactor Dev setup docs refactor Jun 12, 2017
@dralley dralley added the 3.0 label Jun 13, 2017
Copy link
Contributor

@werwty werwty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! Just need a couple of small sphinx related fixes to get the docs building.


`Ansible <https://docs.ansible.com/ansible/index.html>`_ playbooks can be used to provision a machine with a developer installation of Pulp. It is highly recommended that you develop Pulp on a virtual machine. Have a look at our :ref:`using-ansible` section to change how your machine is provisioned.

`Vagrant <https://docs.vagrantup.com/>`_ is used to create and manage development virtual machines. Configuring Vagrant is beyond the scope of this document, but you can find suggestions in the comments of ``Vagrantfile.example`` and on the `wiki <https://pulp.plan.io/projects/pulp/wiki/Pulp_3_Developer_Notes>)`_.
Copy link
Contributor

@werwty werwty Jun 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Pulp_3_Developer_Notes>)/Pulp_3_Developer_Notes>/

Put Source Code on your Host
----------------------------

Use the :ref:`getsource` guide to put the code into a development directory on your *host machine*. If you use one of the default playbooks, ``pulp_devel_dir`` is set for you, see `variables`_.
Copy link
Contributor

@werwty werwty Jun 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/`variables`/:ref:`variables`/


.. note::

The git repositories required by each role are documented in `ansible-roles`_.
Copy link
Contributor

@werwty werwty Jun 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/`ansible-roles`_/:ref:`ansible-roles`/


*Role order matters*:

+---------------+----------+------------------------+-----------------------------------------------+
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really awesome!

@asmacdo asmacdo merged commit da416e1 into pulp:3.0-dev Jun 21, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
3 participants