Story #1988
closedAs a new developer, I am able to get started from the documentation
100%
Description
The developer docs are very difficult to use when starting from square 1. There is not a clear path through them, there is outdated information, and there is too much assumed knowledge. In order to increase community contribution, we should make it very easy to get started with a development environment.
This story is to audit the developer docs to make sure that someone without any experience with Pulp can:
1. Make a developer install of Pulp using vagrant
2. Make a developer install using dev-setup script.
3. The developer is aware of the steps that they need to take to find and fix their first bug.
Updated by amacdona@redhat.com almost 8 years ago
- Project changed from Python Support to Pulp
Updated by bmbouter almost 8 years ago
The Qpid dependency is incorrect[0]. It recommends qpid-cpp-server-store but instead it should recommend qpid-cpp-server-linearstore
[0]: http://pulp.readthedocs.io/en/latest/dev-guide/contributing/dev_setup.html#dependencies
Updated by amacdona@redhat.com over 7 years ago
- Sprint Candidate changed from No to Yes
Updated by bmbouter over 7 years ago
- Groomed changed from No to Yes
This story makes sens to me. It's basically a cleanup of the developer onboarding docs which we really need!
Updated by fdobrovo over 7 years ago
- Category set to 23
- Assignee set to fdobrovo
- Tags Documentation added
Updated by fdobrovo over 7 years ago
- Status changed from NEW to ASSIGNED
- Sprint/Milestone set to 24
Updated by ipanova@redhat.com over 7 years ago
- Status changed from ASSIGNED to POST
Updated by mhrivnak over 7 years ago
- Sprint/Milestone changed from 25 to 26
Moving to sprint 8 since work is ongoing.
Added by fdobrovo about 7 years ago
Added by fdobrovo about 7 years ago
Revision d538632d | View on GitHub
Story 1988 - Easier documentation for new developers
closes #1988 https://pulp.plan.io/issues/1988
dev-guide/contributing/branching.rst
- Explain Bug fix branches more in detail
- Explain Feature Branches more in detail
- Add Naming of the new Branch section
- Add note about multiple commits
dev-guide/contributing/bugs.rst
- Add how to proceed when fixing bug
- Add note how to view logs
dev-guide/contributing/dev_setup.rst
- Add note about libivrt and docker support
- Add note how to handle not removed virbr
- Fix example in Creating the Vagrant environment
- Add section Using Vagrant
- Fix renamed package qpid-cpp-server-store -> qpid-cpp-server-linearstore
dev-guide/policies/style.rst
- Add flake8 suggestion
dev-guide/policies/testing.rst
- Add note about coverage
user-guide/glossary.rst
- Add publish
- Add sync
Updated by fdobrovo about 7 years ago
- Status changed from POST to MODIFIED
- % Done changed from 0 to 100
Applied in changeset pulp|d538632da07ea0664c6152dc19019cc2c1dc09bc.
Updated by pcreech almost 7 years ago
- Status changed from 5 to CLOSED - CURRENTRELEASE
Story 1988 - Easier documentation for new developers
closes #1988 https://pulp.plan.io/issues/1988
dev-guide/contributing/branching.rst
dev-guide/contributing/bugs.rst
dev-guide/contributing/dev_setup.rst
dev-guide/policies/style.rst
dev-guide/policies/testing.rst
user-guide/glossary.rst