Actions
Story #1988
closedAs a new developer, I am able to get started from the documentation
Start date:
Due date:
% Done:
100%
Estimated time:
Platform Release:
2.13.0
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Documentation, Pulp 2
Sprint:
Sprint 8
Quarter:
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.
Actions
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