From 67f9383dabfc130935f9d6d469f8dcd10e5154d5 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Apr 19 2016 08:40:23 +0000 Subject: Adjust the documentation based on @puiterwijk's feedback --- diff --git a/doc/install.rst b/doc/install.rst index c1269ce..4b2e3bd 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -245,8 +245,8 @@ You can save the current revision in the database using the following command: alembic stamp $(alembic heads |awk '{ print $1 }') The ``cd /etc/pagure`` is needed as the command must be run in the folder -where is the file ``alembic.ini``. This file contains two important -information: +where the file ``alembic.ini`` is. This file contains two important pieces +of information: * ``sqlalchemy.url`` which is the URL used to connect to the database, likely the same URL as the one in ``pagure.cfg``. diff --git a/doc/usage.rst b/doc/usage.rst index 7ac0b3f..09e7587 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -23,13 +23,7 @@ overview page of the project. On the menu on the right side, there is a menu you will be given the URLs to the other three git repos. Each section correspond to one of the four git repositories created for each -project: - -* A git repository containing the source code, displayed in the main section - of the pagure project. -* A git repository for the documentation -* A git repository for the issues and their metadata -* A git repository for the metadata for pull-requests +project. diff --git a/doc/usage/using_webhooks.rst b/doc/usage/using_webhooks.rst index 0040b1e..4e1d4ae 100644 --- a/doc/usage/using_webhooks.rst +++ b/doc/usage/using_webhooks.rst @@ -6,11 +6,11 @@ Basically, pagure will make a HTTP POST request to one or more third party server/application with information about what is or just happened. To set-up a web-hook, simply go to the settings page of your project and -enter the URL to the server that will receive the notifications. +enter the URL to the server/endpoint that will receive the notifications. -In the settings page is also present a web-hook key which is used by the -server to sign the message sent and which you can use to ensure the -notifications received are coming from the right source. +There is, in the settings page, a web-hook key which is used by the +server (here pagure) to sign the message sent and which you can use to +ensure the notifications received are coming from the right source. Each POST request made contains two specific headers: