#128 Create Pagure pull request how-to documentation
Closed: Duplicate 6 years ago Opened 6 years ago by jflory7.

Summary

Create a "how-to" page for making a pull request against a Pagure project in the fedora-contribution-howto repo

Background

At Flock 2017, we discussed how to use Fedora Classrooms as a way to enable newcomers to contribute to Fedora. One idea was creating a "how-to" video and documentation for making a pull request on Pagure.

The goal of doing this is to help make a technical task easier and also provide "best practices" for contributing to a Pagure project.

Details

The page should be as simple as possible. Use of ordered lists will be important. Once we have a draft, we should consult with the Pagure team for any feedback or changes.

We also discussed making a video for this. I created a "first draft" video that can be found here.

Action

  1. Create a one-page guide on how to contribute to a Pagure project in the fedora-contribution-howto repo
  2. Seek feedback from Pagure developers once first draft is ready
  3. Publish page by the end of Fedora 28 release cycle

Metadata Update from @jflory7:
- Issue priority set to: no deadline
- Issue set to the milestone: Fedora 28 (to May 2018)
- Issue tagged with: easyfix, help wanted, onboarding

6 years ago

Metadata Update from @jflory7:
- Issue tagged with: meeting

6 years ago

Discussed in 2018-01-15 meeting.


We opened this ticket up for help, and @meskarune volunteered to help write a basic intro to cover how to make a Pagure pull request! Once she has a draft ready, we'll cycle around to the Pagure team for feedback, and work with @bex on getting a table of contents ready in the Fedora contribution guide.

Metadata Update from @jflory7:
- Issue untagged with: help wanted
- Issue assigned to meskarune
- Issue priority set to: normal (1-2 weeks) (was: no deadline)

6 years ago

Apparently documentation for pull requests on pagure exists here: https://docs.pagure.org/pagure/usage/pull_requests.html

Do we want to continue with this specific how to? Or link to the pagure docs from some "how to contribute" page? Do the pagure docs need screenshots and additional information?

We discussed this in IRC. I didn't realize the above page already existed. The docs seem pretty thorough, so I think we can use it as a reference in the contributing guide, instead of making it a part of the contributing guide. I'm going to close this ticket.

This was my fault for not digging harder before filing this ticket.

However, @meskarune noticed an accessibility flaw with the footer, where the documentation is linked. She is filing an issue against Pagure for that.

Metadata Update from @jflory7:
- Issue untagged with: meeting
- Issue close_status updated to: Duplicate
- Issue status updated to: Closed (was: Open)

6 years ago

Login to comment on this ticket.

Metadata