#137 Improve dev environment docs to explain forking / other starting steps
Closed: complete 5 years ago by jflory7. Opened 5 years ago by jflory7.

Summary

Improve development environment documentation to explain first steps like setting up a SSH key, forking, cloning the fork, etc.

Background

@janyu99 pointed this out in #100 when setting up the development environment. For beginners, it's not an obvious first step since most people getting started with the Fedora community have not worked with Pagure before. It would be helpful to point out some of these steps for the benefit of first-timers.

Details

If something is already written in the Pagure usage docs, it shouldn't be written twice (e.g. the pull requests docs page). In our docs, we could point to the Pagure docs as a reference where needed.

Otherwise, we can write new docs on our own where needed.

Outcome

  • Easier for beginners to get started with the project
  • Correctly documenting actual first steps to set up a dev environment

Metadata Update from @jflory7:
- Issue assigned to janyu99

5 years ago

@janyu99 I opened this from your comment in #100. Feel free to work on this as a first contribution! :thumbsup:

@jflory7 Great! I'll start working on this immediately :pencil:

@jflory7 I noticed that the setup instructions were updated with the 'fork and clone' step, so I just added one more step to the instructions to tie it all together :thumbsup: Here is my pull request: https://pagure.io/fedora-commops/fedora-happiness-packets/pull-request/142

@janyu99 Thanks, this PR did the trick. I'm going to close this ticket as complete! Thanks for working on this. :clapper:

Metadata Update from @jflory7:
- Issue close_status updated to: complete
- Issue status updated to: Closed (was: Open)

5 years ago

Metadata Update from @jflory7:
- Issue set to the milestone: Summer Coding 2019: community bonding

5 years ago

Metadata Update from @janyu99:
- Assignee reset

5 years ago

Login to comment on this ticket.

Metadata