From 0afe07bb0272d39e316668550cc73d6e2621495f Mon Sep 17 00:00:00 2001 From: Clement Verna Date: Sep 27 2017 20:05:27 +0000 Subject: [PATCH 1/2] Update the documentation on how to create pull requests. Signed-off-by: Clement Verna --- diff --git a/doc/usage/_static/pagure_pr_commits.png b/doc/usage/_static/pagure_pr_commits.png new file mode 100644 index 0000000..5040bd8 Binary files /dev/null and b/doc/usage/_static/pagure_pr_commits.png differ diff --git a/doc/usage/_static/pagure_pr_overview.png b/doc/usage/_static/pagure_pr_overview.png new file mode 100644 index 0000000..e5a5065 Binary files /dev/null and b/doc/usage/_static/pagure_pr_overview.png differ diff --git a/doc/usage/_static/pagure_pr_pull_requests.png b/doc/usage/_static/pagure_pr_pull_requests.png new file mode 100644 index 0000000..2ecf6ed Binary files /dev/null and b/doc/usage/_static/pagure_pr_pull_requests.png differ diff --git a/doc/usage/pull_requests.rst b/doc/usage/pull_requests.rst index b6533cf..64b14e7 100644 --- a/doc/usage/pull_requests.rst +++ b/doc/usage/pull_requests.rst @@ -17,19 +17,68 @@ Before you can open a pull request, you need to complete the :ref:`first-steps` and :ref:`create-fork` of the project you would like to contribute to. Once you have a fork and you have pushed a `git branch `_ containing one or more `commits `_, you are -ready to contribute to the project. Navigate to the project's Pull Request page -and click on the ``File Pull Request`` button. +ready to contribute to the project. -A dropdown menu should appear containing the git branches in your fork. Select the -branch containing your changes. You will be taken to a page where you can customize -the title of your Pull Request and its description. By default, this is populated -using your commit message. +Pagure to Pagure pull request +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Once you are satisfied with your title and description, click ``Create``. +You can create a pull request from a pagure project, using one of the following options -Congratulations! It is now up to the project maintainer to accept your changes by -merging them. +From the project overview +************************* +#. Go the the ``overview`` tab of your fork. + +#. Locate your feature branch (Right hand side), and press the button ``New PR`` button. + +#. Fill the Create a pull request form (Title and Description) and create your pull request. + +Notes: The ``New PR`` button appears only if there are commits not available in the main branch. + +.. image:: _static/pagure_pr_overview.png + :target: ../_images/pagure_pr_overview.png + +From the commits history +************************ + +#. Go to the ``commit`` tab of your fork and select your feature branch. + +#. Press the ``create pull request`` button (above the latest commits). + +#. Fill the Create a pull request form (Title and Description) and create your pull request. + +.. image:: _static/pagure_pr_commits.png + :target: ../_images/pagure_pr_commits.png + +From the pull requests list +*************************** + +#. Go to the main project's (not your fork) pull requests list and press the ``File Pull Request`` button. + +#. Select the feature branch containing your changes from the dropdown menu. + +#. Fill the Create a pull request form (Title and Description) and create your pull request. + +.. image:: _static/pagure_pr_pull_requests.png + :target: ../_images/pagure_pr_pull_requests.png + +Remote Git to Pagure pull request +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You can create a pull request from an other git hosting platform (eg github, gitlab). +This is a remote pull request. + +From the pull requests list +*************************** + +#. Go to the main project's (not your fork) pull requests list and press the ``File Pull Request`` button. + +#. Select the ``Remote pull-request`` option from the dropdown menu. + +#. Fill the New remote pull-request form (Title, Git repo address and Git branch) and create your remote pull request. + +Congratulations! It is now up to the project maintainer to accept your changes +by merging them. .. _update-pull-request: From b1a034902cff5977b9a83422eb2dc1bd6f21ed5e Mon Sep 17 00:00:00 2001 From: Clement Verna Date: Sep 27 2017 20:13:00 +0000 Subject: [PATCH 2/2] Fixing the link of the images target Signed-off-by: Clement Verna --- diff --git a/doc/overview.rst b/doc/overview.rst index dde8cae..81af321 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -15,13 +15,13 @@ components listed above are optional. Here is a diagram representing pagure without all the optional components: .. image:: _static/overview_simple.png - :target: _static/overview_simple.png + :target: _images/overview_simple.png And here is a diagram of all the components together: .. image:: _static/overview.png - :target: _static/overview.png + :target: _images/overview.png Pagure core application ----------------------- diff --git a/doc/usage/first_steps.rst b/doc/usage/first_steps.rst index 1ed7ef1..00de2c2 100644 --- a/doc/usage/first_steps.rst +++ b/doc/usage/first_steps.rst @@ -58,14 +58,14 @@ To upload your public key onto pagure: the top right corner, there, select ``My settings``. .. image:: _static/pagure_my_settings.png - :target: _static/pagure_my_settings.png + :target: ../_images/pagure_my_settings.png 2. In the authentication section of your user settings copy the content of your ``id_rsa.pub`` file in the Public SSH key text box and save your ssh key settings. .. image:: _static/pagure_add_ssh_key.png - :target: _static/pagure_add_ssh_key.png + :target: ../_images/pagure_add_ssh_key.png .. note:: Pagure support multiple ssh keys per user, to add more than a ssh key to your user account just add your new ssh key in your authentication diff --git a/doc/usage/pr_custom_page.rst b/doc/usage/pr_custom_page.rst index 2fdeb5e..b209232 100644 --- a/doc/usage/pr_custom_page.rst +++ b/doc/usage/pr_custom_page.rst @@ -65,7 +65,7 @@ And place in this file the following content: * And this is how it will look like .. image:: _static/pagure_custom_pr.png - :target: _static/pagure_custom_pr.png + :target: ../_images/pagure_custom_pr.png diff --git a/doc/usage/roadmap.rst b/doc/usage/roadmap.rst index d2c3902..f428b75 100644 --- a/doc/usage/roadmap.rst +++ b/doc/usage/roadmap.rst @@ -33,4 +33,4 @@ For a project named ``test`` on ``pagure.io``. * And this is how it will look like .. image:: _static/pagure_roadmap2.png - :target: _static/pagure_roadmap2.png + :target: ../_images/pagure_roadmap2.png diff --git a/doc/usage/ticket_templates.rst b/doc/usage/ticket_templates.rst index e83ec74..97450b9 100644 --- a/doc/usage/ticket_templates.rst +++ b/doc/usage/ticket_templates.rst @@ -68,7 +68,7 @@ And place in this file the following content: * And this is how it will look like .. image:: _static/pagure_ticket_template.png - :target: _static/pagure_ticket_template.png + :target: ../_images/pagure_ticket_template.png diff --git a/doc/usage/trouble/inaccessible_pr.rst b/doc/usage/trouble/inaccessible_pr.rst index 7192807..1ada50e 100644 --- a/doc/usage/trouble/inaccessible_pr.rst +++ b/doc/usage/trouble/inaccessible_pr.rst @@ -15,7 +15,7 @@ When trying to open a pull-request, if you run into this error: (Where ``XXX`` is a branch name). .. image:: _static/inaccessible_pr.png - :target: _static/inaccessible_pr.png + :target: ../../_images/inaccessible_pr.png (Here ``XXX`` is ``m2``).