Project

Profile

Help

Story #1988

closed

As a new developer, I am able to get started from the documentation

Added by amacdona@redhat.com about 6 years ago. Updated about 2 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
-
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 #1

Updated by amacdona@redhat.com about 6 years ago

  • Description updated (diff)
Actions #2

Updated by amacdona@redhat.com about 6 years ago

  • Project changed from Python Support to Pulp
Actions #3

Updated by bmbouter about 6 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

Actions #4

Updated by amacdona@redhat.com almost 6 years ago

  • Sprint Candidate changed from No to Yes
Actions #5

Updated by bmbouter almost 6 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!

Actions #6

Updated by fdobrovo almost 6 years ago

  • Category set to 23
  • Assignee set to fdobrovo
  • Tags Documentation added
Actions #7

Updated by fdobrovo almost 6 years ago

  • Status changed from NEW to ASSIGNED
  • Sprint/Milestone set to 24
Actions #8

Updated by mhrivnak almost 6 years ago

  • Sprint/Milestone changed from 24 to 25
Actions #9

Updated by ipanova@redhat.com almost 6 years ago

  • Status changed from ASSIGNED to POST
Actions #10

Updated by mhrivnak almost 6 years ago

  • Sprint/Milestone changed from 25 to 26

Moving to sprint 8 since work is ongoing.

Added by fdobrovo over 5 years ago

Revision d538632d

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

Added by fdobrovo over 5 years ago

Revision d538632d

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
Actions #11

Updated by fdobrovo over 5 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100
Actions #12

Updated by semyers over 5 years ago

  • Platform Release set to 2.13.0
Actions #13

Updated by pcreech about 5 years ago

  • Status changed from MODIFIED to 5
Actions #14

Updated by pcreech about 5 years ago

  • Status changed from 5 to CLOSED - CURRENTRELEASE
Actions #15

Updated by bmbouter over 4 years ago

  • Sprint set to Sprint 8
Actions #16

Updated by bmbouter over 4 years ago

  • Sprint/Milestone deleted (26)
Actions #17

Updated by bmbouter about 3 years ago

  • Tags Pulp 2 added
Actions #18

Updated by bmbouter about 2 years ago

  • Category deleted (23)

Also available in: Atom PDF