debian/pagure
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fixing typos on documentation.

Browse source
This commit is contained in:
Sergio Durigan Junior 2016-08-09 00:53:35 -04:00
parent ffcd0e2e39
commit 15ed3939d2
2 changed files with 223 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

222
debian/patches/0003-Fixing-typos-on-documentation.patch vendored Normal file
View file

@ -0,0 +1,222 @@
From: Sergio Durigan Junior <sergiodj@sergiodj.net>
Date: Tue, 9 Aug 2016 00:53:13 -0400
Subject: Fixing typos on documentation.
---
doc/configuration.rst | 28 ++++++++++++++--------------
doc/development.rst | 2 +-
doc/install.rst | 2 +-
doc/install_evs.rst | 2 +-
doc/install_webhooks.rst | 2 +-
doc/usage/ticket_templates.rst | 2 +-
doc/usage/using_webhooks.rst | 2 +-
7 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/doc/configuration.rst b/doc/configuration.rst
index eec82c7..cb910e4 100644
--- a/doc/configuration.rst
+++ b/doc/configuration.rst
@@ -155,7 +155,7 @@ https.
FROM_EMAIL
~~~~~~~~~~
-This setting allows to specify the email address used by this pagure instance
+This setting allows one to specify the email address used by this pagure instance
when sending emails (notifications).
Defaults to: ``pagure@pagure.org``
@@ -164,7 +164,7 @@ Defaults to: ``pagure@pagure.org``
DOMAIN_EMAIL_NOTIFICATIONS
~~~~~~~~~~~~~~~~~~~~~~~~~~
-This setting allows to specify the domain used by this pagure instance
+This setting allows one to specify the domain used by this pagure instance
when sending emails (notifications). More precisely, this setting is used
when building the ``msg-id`` header of the emails sent.
@@ -190,7 +190,7 @@ gitolite is ran.
GITOLITE_VERSION
~~~~~~~~~~~~~~~~
-This configuration key allows to specify which version of gitolite you are
+This configuration key allows one to specify which version of gitolite you are
using, it can be either ``2`` or ``3``.
Defaults to: ``3``.
@@ -338,7 +338,7 @@ Defaults to: ``50``.
SMTP_SERVER
~~~~~~~~~~~
-This configuration key allows to configure the SMTP server to use when
+This configuration key allows one to configure the SMTP server to use when
sending emails.
Defaults to: ``localhost``.
@@ -358,7 +358,7 @@ Defaults to: ``25``
SMTP_SSL
~~~~~~~~
-This configuration key allows to specify whether the SMTP connections
+This configuration key allows one to specify whether the SMTP connections
should secured over SSL
Defaults to: ``False``
@@ -384,7 +384,7 @@ Defaults to: ``None``
SHORT_LENGTH
~~~~~~~~~~~~
-This configuration key allows to configure the length of the commit ids or
+This configuration key allows one to configure the length of the commit ids or
file hex displayed in the user interface.
Defaults to: ``6``.
@@ -393,7 +393,7 @@ Defaults to: ``6``.
BLACKLISTED_PROJECTS
~~~~~~~~~~~~~~~~~~~~
-This configuration key allows to set a list of project name that are forbidden.
+This configuration key allows one to set a list of project name that are forbidden.
This list is used for example to avoid conflicts at the URL level between the
static files located under ``/static/`` and a project that would be named
``static`` and thus be located at ``/static``.
@@ -412,7 +412,7 @@ Defaults to:
CHECK_SESSION_IP
~~~~~~~~~~~~~~~~
-This configuration key allows to configure whether to check the user's IP
+This configuration key allows one to configure whether to check the user's IP
address when retrieving its session. This makes things more secure but
under certain setup it might not work (for example if there are proxies
in front of the application).
@@ -423,7 +423,7 @@ Defaults to: ``True``.
PAGURE_AUTH
~~~~~~~~~~~~
-This configuration key allows to specify which authentication method to use.
+This configuration key allows one to specify which authentication method to use.
Pagure supports currently two authentication methods, one relying on the
Fedora Account System `FAS <https://admin.fedoraproject.org/accounts>`_,
the other relying on local user accounts.
@@ -435,7 +435,7 @@ Defaults to: ``fas``.
IP_ALLOWED_INTERNAL
~~~~~~~~~~~~~~~~~~~
-This configuration key allows to specify which IP addresses are allowed
+This configuration key allows one to specify which IP addresses are allowed
to access the internal API endpoint. These endpoints are accessed by the
milters for example and allow to perform action in the name of someone else.
So they are sensitive, thus the check for the origin of the request using
@@ -447,7 +447,7 @@ Defaults to: ``['127.0.0.1', 'localhost', '::1']``.
MAX_CONTENT_LENGTH
~~~~~~~~~~~~~~~~~~
-This configuration key allows to specify the maximum size allowed when
+This configuration key allows one to specify the maximum size allowed when
uploading content to pagure (for example, screenshots to a ticket).
Defaults to: ``4 * 1024 * 1024`` which corresponds to 4 megabytes.
@@ -456,7 +456,7 @@ Defaults to: ``4 * 1024 * 1024`` which corresponds to 4 megabytes.
ENABLE_TICKETS
~~~~~~~~~~~~~~
-This configuration key allows to activate or de-activate the ticketing system
+This configuration key allows one to activate or de-activate the ticketing system
for all the projects hosted on this pagure instance.
Defaults to: ``True``
@@ -465,7 +465,7 @@ Defaults to: ``True``
ENABLE_NEW_PROJECTS
~~~~~~~~~~~~~~~~~~~
-This configuration key allows to create or forbids creating new projects in
+This configuration key allows one to create or forbids creating new projects in
the user interface of this pagure instance.
Defaults to: ``True``
@@ -474,7 +474,7 @@ Defaults to: ``True``
ENABLE_DEL_PROJECTS
~~~~~~~~~~~~~~~~~~~
-This configuration key allows to delete or forbids deleting projects in
+This configuration key allows one to delete or forbids deleting projects in
the user interface of this pagure instance.
Defaults to: ``True``
diff --git a/doc/development.rst b/doc/development.rst
index 2fb8d7b..10a4cb4 100644
--- a/doc/development.rst
+++ b/doc/development.rst
@@ -100,7 +100,7 @@ You should be able to access the server at http://localhost:5000
Every time you save a file, the project will be automatically restarted
-so you can see your change immediatly.
+so you can see your change immediately.
diff --git a/doc/install.rst b/doc/install.rst
index 7490087..14732c5 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -3,7 +3,7 @@ Installing pagure
There are two ways to install pagure:
-* via the RPM package (recommanded if you are using a RPM-based linux distribution)
+* via the RPM package (recommended if you are using a RPM-based linux distribution)
* via the setup.py
diff --git a/doc/install_evs.rst b/doc/install_evs.rst
index 51f4965..0ccbcc9 100644
--- a/doc/install_evs.rst
+++ b/doc/install_evs.rst
@@ -2,7 +2,7 @@ Installing pagure's EventSource server
======================================
Eventsource or Server Sent Events are messages sent from a server to a web
-browser. It allows to refresh a page "live", ie, without the need to reload
+browser. It allows one to refresh a page "live", ie, without the need to reload
it entirely.
diff --git a/doc/install_webhooks.rst b/doc/install_webhooks.rst
index 2aec5e6..8e5e0b0 100644
--- a/doc/install_webhooks.rst
+++ b/doc/install_webhooks.rst
@@ -3,7 +3,7 @@ Installing pagure's web-hooks notification system
Web-hooks are a notification system upon which a system makes a http POST
request with some data upon doing an action. This allows notifying a system
-that an action has occured.
+that an action has occurred.
If you want more information feel free to check out the corresponding page
on wikipedia: `https://en.wikipedia.org/wiki/Webhook
diff --git a/doc/usage/ticket_templates.rst b/doc/usage/ticket_templates.rst
index 9c45651..625d2ff 100644
--- a/doc/usage/ticket_templates.rst
+++ b/doc/usage/ticket_templates.rst
@@ -10,7 +10,7 @@ often requested/needed.
The templates are provided in the git repository containing the meta-data
for the tickets.
They must be placed under a ``templates`` folder in this git repository,
-end with ``.md``and as the extension suggests can be formated as markdown.
+end with ``.md``and as the extension suggests can be formatted as markdown.
If you create a template ``templates/default.md``, it will be shown by
default when someone ask to create a new ticket.
diff --git a/doc/usage/using_webhooks.rst b/doc/usage/using_webhooks.rst
index 7e48058..f5127ec 100644
--- a/doc/usage/using_webhooks.rst
+++ b/doc/usage/using_webhooks.rst
@@ -21,7 +21,7 @@ Each POST request made contains two specific headers:
``X-Pagure-Topic`` is a global header giving a clue about the type of action
-that just occured. For example ``issue.edit``.
+that just occurred. For example ``issue.edit``.
``X-Pagure-Signature`` contains the signature of the message allowing to

1
debian/patches/series vendored
View file

@ -1,2 +1,3 @@
0001-Support-python-bcrypt-instead-of-py-bcrypt.patch
0002-Use-bare-repo-for-testing.patch
0003-Fixing-typos-on-documentation.patch