#4566 Fix spelling errors on doc/.
Merged 4 years ago by pingou. Opened 4 years ago by sergiodj.
sergiodj/pagure spelling-fixes-doc  into  master

file modified
+11 -11
@@ -385,7 +385,7 @@ 

  - Correctly align edit button for groups in repo settings (Ryan Lerch)

  - Fix all-around sidebar heading borders (Ryan Lerch)

  - Remove incorrect count label on related PRs (Ryan Lerch)

- - Move attachements to sidebar (Ryan Lerch)

+ - Move attachments to sidebar (Ryan Lerch)

  - Add reporter and assignee to notification emails headers (Lenka Segura)

  - Make sure that ticket changes don't get duplicated (Patrick Uiterwijk)

  - Fix the git ssh urls in the templates
@@ -926,7 +926,7 @@ 

  - Include the targeted branch in the list of PRs

  - Separately link user/namespace/name

  - Fix the pagination when listing projects via the view_projects endpoints

- - Retain access when transfering ownership of the project (Matt Prahl)

+ - Retain access when transferring ownership of the project (Matt Prahl)

  

  

  3.6 (2017-08-14)
@@ -1189,7 +1189,7 @@ 

  - When creating the pull-request, save the commit_start and commit_stop

  - Ensure there is a date before trying to humanize it

  - Fixing showing tags even when some of them are not formatted as expected

- - Allow repo user to Take/Drop assigment of issue (Vivek Anand)

+ - Allow repo user to Take/Drop assignment of issue (Vivek Anand)

  - Add merge status column in pull requests page (Abhijeet Kasurde)

  - Allow user with ticket access to edit custom fields, metadata and the privacy

    flag (Vivek Anand)
@@ -1231,7 +1231,7 @@ 

    (Eashan)

  - Document how to filter out for issues having a certain tag in the tips and

    tricks section

- - Allow to manually triggering a run of pagure-ci via a list of sentences set in

+ - Allow one to manually triggering a run of pagure-ci via a list of sentences set in

    the configuration

  - Add support for admin API token to pagure-admin

  - Make clicking on 'Unassigned' filter the unassigned PR as it does for issues
@@ -1325,7 +1325,7 @@ 

  - Add a configuration key allowing to hide some projects that users have access

    to only via these groups

  - Fix figuring out which branches are not merged in namespaced project

- - Automatically link the commits mentionned in a ticket if their hash is 7 chars

+ - Automatically link the commits mentioned in a ticket if their hash is 7 chars

    or more

  - Allow dropping all the priorities info of an issue

  - Do not edit multiple times the milestone info when updating a ticket
@@ -1418,7 +1418,7 @@ 

  - Make interacting with the different git repos a locked process to avoid

    lost/orphan commits

  - Update API doc for api_view_user (Clement Verna)

- - Dont return 404 when viewing empty files (Pradeep CE (cep))

+ - Don't return 404 when viewing empty files (Pradeep CE (cep))

  - Do not automatically update the last_updated or updated_on fields

  - Make alembic use the DB url specified in the configuration file of pagure

  - Only connect to the smtp server if we're going to send an email
@@ -1472,7 +1472,7 @@ 

  - Let the notifications render correctly when added by the SSE server

  - Fix the URL for pull request on the list of branches of a fork (Rahul Bajaj)

  - Adjust the markdown processor to have 1 regex for all cross-project links

- - Remove unsued variables (Farhaan Bukhsh)

+ - Remove unused variables (Farhaan Bukhsh)

  - Hide the title of private tickets when linking to them in markdown

  - Show user activity in pagure on the user's page

  - Add the possibility to subscribe to issues
@@ -1648,7 +1648,7 @@ 

  - Don't track pagure_env (venv) dir (Paul W. Frields)

  - Setting Mail-Followup-To when sending message to users (Sergio Durigan Junior)

    (Fixed by Ryan Lerch and I)

- - Fixed the tickets hook so that we dont ignore the files committed in the first

+ - Fixed the tickets hook so that we don't ignore the files committed in the first

    commit (Clement Verna)

  - Fix behavior of view of tree if default branch is not 'master' (Vivek Anand)

  - Fix checking the release folder for forks
@@ -1809,11 +1809,11 @@ 

  2.2.1 (2016-06-01)

  ------------------

  

- - Fix showing the inital comment on PR having only one commit (Ryan Lerch)

+ - Fix showing the initial comment on PR having only one commit (Ryan Lerch)

  - Fix diffs not showing for additions/deletions for files under 1000 lines (Ryan

    Lerch)

  - Split out the commits page to a template of its own (Ryan Lerch)

- - Fix hightlighting the commits tab on commit view

+ - Fix highlighting the commits tab on commit view

  - Fix the fact that the no readme box show on empty repo (Ryan Lerch)

  

  
@@ -1964,7 +1964,7 @@ 

  - Fix the of the Docs tab and the Fork button with rounded corners (Pedro Lima)

  - Expand the information in the notifications message when a PR is updated (Ryan

    Lerch)

- - Fix hidding the reply buttons when users are not authenticated (Paul W. Frields)

+ - Fix hiding the reply buttons when users are not authenticated (Paul W. Frields)

  - Improve the description of the git hooks (Lubomír Sedlář)

  - Allow reply to a notification of pagure and setting the reply email address as

    Cc

file modified
+36 -36
@@ -477,7 +477,7 @@ 

  FAST_CELERY_QUEUE

  ~~~~~~~~~~~~~~~~~

  

- This configuration key allows to specify a dedicated queue for tasks that

+ This configuration key can be used to specify a dedicated queue for tasks that

  are triggered by the web frontend and need to be processed quickly for the

  best user experience.

  
@@ -489,7 +489,7 @@ 

  MEDIUM_CELERY_QUEUE

  ~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to specify a dedicated queue for tasks that

+ This configuration key can be used to specify a dedicated queue for tasks that

  are triggered by the web frontend and need to be processed but aren't critical

  for the best user experience.

  
@@ -500,7 +500,7 @@ 

  SLOW_CELERY_QUEUE

  ~~~~~~~~~~~~~~~~~

  

- This configuration key allows to specify a dedicated queue for tasks that

+ This configuration key can be used to specify a dedicated queue for tasks that

  are triggered by the web frontend, are slow and do not impact the user

  experience in the user interface.

  
@@ -520,7 +520,7 @@ 

  STOMP_NOTIFICATIONS

  ~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to turn on or off notifications via

+ This configuration key can be used to turn on or off notifications via

  `stomp protocol <https://stomp.github.io/>`_. All other stomp-related

  settings don't need to be present if this is set to ``False``.

  
@@ -570,7 +570,7 @@ 

  ALWAYS_STOMP_ON_COMMITS

  ~~~~~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to enforce `stomp <https://stomp.github.io/>`_

+ This configuration key can be used to enforce `stomp <https://stomp.github.io/>`_

  notifications on commits made on all projects in a pagure instance.

  

  Defaults to: ``False``.
@@ -583,14 +583,14 @@ 

  ~~~~

  

  This configuration key lists all the ACLs that can be associated with an API

- token with a short description of what the ACL allows to do.

+ token with a short description of what the ACL allows one to do.

  This key it not really meant to be changed unless you really know what you

  are doing.

  

  USER_ACLS

  ~~~~~~~~~

  

- This configuration key allows to list which of the ACLs listed in ``ACLS``

+ This configuration key can be used to list which of the ACLs listed in ``ACLS``

  can be associated with an API token of a project in the (web) user interface.

  

  Use this configuration key in combination with ``ADMIN_API_ACLS`` to disable
@@ -603,7 +603,7 @@ 

  ADMIN_API_ACLS

  ~~~~~~~~~~~~~~

  

- This configuration key allows to list which of the ACLs listed in ``ACLS``

+ This configuration key can be used to list which of the ACLs listed in ``ACLS``

  can be generated by the ``pagure-admin`` CLI tool by admins.

  

  Defaults to: ``['issue_comment', 'issue_create', 'issue_change_status', 'pull_request_flag', 'pull_request_comment', 'pull_request_merge', 'generate_acls_project', 'commit_flag', 'create_branch']``
@@ -612,7 +612,7 @@ 

  CROSS_PROJECT_ACLS

  ~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to list which of the ACLs listed in ``ACLS``

+ This configuration key can be used to list which of the ACLs listed in ``ACLS``

  can be associated with a project-less API token in the (web) user interface.

  These project-less API tokens can be generated in the user's settings page

  and allows action in multiple projects instead of being restricted to a
@@ -1034,7 +1034,7 @@ 

  ENABLE_TICKETS_NAMESPACE

  ~~~~~~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to restrict the namespace in which the ticketing

+ This configuration key can be used to restrict the namespace in which the ticketing

  system is enabled.

  So if your pagure instance has ``ENABLE_TICKETS`` as ``True`` and sets

  ``ENABLE_TICKETS_NAMESPACE`` to ``['tests', 'infra']`` only the projects opened
@@ -1124,7 +1124,7 @@ 

  FEDMSG_NOTIFICATIONS

  ~~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to turn on or off notifications via `fedmsg

+ This configuration key can be used to turn on or off notifications via `fedmsg

  <http://www.fedmsg.com/>`_.

  

  Defaults to: ``False``.
@@ -1133,7 +1133,7 @@ 

  FEDORA_MESSAGING_NOTIFICATIONS

  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to turn on or off sending notifications via

+ This configuration key can be used to turn on or off sending notifications via

  `fedora-messaging <>`_.

  

  Defaults to: ``False``.
@@ -1142,7 +1142,7 @@ 

  ALWAYS_FEDMSG_ON_COMMITS

  ~~~~~~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to enforce `fedmsg <http://www.fedmsg.com/>`_

+ This configuration key can be used to enforce `fedmsg <http://www.fedmsg.com/>`_

  notifications on commits made on all projects in a pagure instance.

  

  Defaults to: ``True``.
@@ -1181,7 +1181,7 @@ 

  LOCAL_SSH_KEY

  ~~~~~~~~~~~~~

  

- This configuration key allows to let pagure administrate the user's ssh keys

+ This configuration key can be used to let pagure administrate the user's ssh keys

  or have a third party tool do it for you.

  In most cases, it will be fine to let pagure handle it.

  
@@ -1191,7 +1191,7 @@ 

  DEPLOY_KEY

  ~~~~~~~~~~

  

- This configuration key allows to disable the deploy keys feature of an

+ This configuration key can be used to disable the deploy keys feature of an

  entire pagure instance. This feature enable to add extra public ssh keys

  that a third party could use to push to a project.

  
@@ -1263,7 +1263,7 @@ 

  USER_NAMESPACE

  ~~~~~~~~~~~~~~

  

- This configuration key allows to enforce that project are namespaced under

+ This configuration key can be used to enforce that project are namespaced under

  the user's username, behaving in this way in a similar fashion as github.com

  or gitlab.com.

  
@@ -1317,10 +1317,10 @@ 

  

  A run of pagure-ci can be manually triggered if some key sentences are added

  as comment to a pull-request, either manually or via the "Rerun CI" dropdown.

- This allows to re-run a test that failed due to some network outage or other

+ This allows one to re-run a test that failed due to some network outage or other

  unexpected issues unrelated to the test suite.

  

- This configuration key allows to define all the sentences that can be used

+ This configuration key can be used to define all the sentences that can be used

  to trigger this pagure-ci run. The format is following: ``{"<sentence>":

  {"name": "<name of the CI>", "description": "<short description>"}}``

  
@@ -1418,7 +1418,7 @@ 

  REQUIRED_GROUPS

  ~~~~~~~~~~~~~~~

  

- The required groups allows to specify in which group an user must be to be

+ The required groups allows one to specify in which group an user must be to be

  added to a project with commit or admin access.

  

  Defaults to: ``{}``
@@ -1520,7 +1520,7 @@ 

  CASE_SENSITIVE

  ~~~~~~~~~~~~~~

  

- This configuration key allows to make this pagure instance case sensitive

+ This configuration key can be used to make this pagure instance case sensitive

  instead of its default: case-insensitive.

  

  Defaults to: ``False``
@@ -1529,7 +1529,7 @@ 

  PROJECT_NAME_REGEX

  ~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to customize the regular expression used to

+ This configuration key can be used to customize the regular expression used to

  validate new project name.

  

  Defaults to: ``^[a-zA-z0-9_][a-zA-Z0-9-_]*$``
@@ -1546,7 +1546,7 @@ 

  ALLOWED_PREFIX

  ~~~~~~~~~~~~~~

  

- This configuration key allows to specify a list of allowed namespaces that

+ This configuration key can be used to specify a list of allowed namespaces that

  will not require creating a group for users to create projects in.

  

  Defaults to: ``[]``
@@ -1568,7 +1568,7 @@ 

  BLACKLISTED_GROUPS

  ~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to blacklist some group names.

+ This configuration key can be used to blacklist some group names.

  

  Defaults to: ``['forks', 'group']``

  
@@ -1576,7 +1576,7 @@ 

  ENABLE_GROUP_MNGT

  ~~~~~~~~~~~~~~~~~

  

- This configuration key allows to turn on or off managing (ie: creating a

+ This configuration key can be used to turn on or off managing (ie: creating a

  group, adding or removing users in that group) groups in this pagure instance.

  If turned off, groups and group members are to be managed outside of pagure

  and synced upon login.
@@ -1587,7 +1587,7 @@ 

  ENABLE_USER_MNGT

  ~~~~~~~~~~~~~~~~

  

- This configuration key allows to turn on or off managing users (adding or

+ This configuration key can be used to turn on or off managing users (adding or

  removing them from a project) in this pagure instance.

  If turned off, users are managed outside of pagure.

  
@@ -1597,7 +1597,7 @@ 

  SESSION_COOKIE_NAME

  ~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to specify the name of the session cookie used

+ This configuration key can be used to specify the name of the session cookie used

  by pagure.

  

  Defaults to: ``'pagure'``
@@ -1606,7 +1606,7 @@ 

  SHOW_PROJECTS_INDEX

  ~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to specify what is shown in the index page of

+ This configuration key can be used to specify what is shown in the index page of

  logged in users.

  

  Defaults to: ``['repos', 'myrepos', 'myforks']``
@@ -1619,7 +1619,7 @@ 

  commit is made.

  However some pagure instances may be using a different notification mechanism on

  commits and thus may not want this feature to double the notifications received.

- This configuration key allows to turn on or off email being sent to people

+ This configuration key can be used to turn on or off email being sent to people

  watching commits on a project upon commits.

  

  Defaults to: ``True``
@@ -1689,7 +1689,7 @@ 

  SYNTAX_ALIAS_OVERRIDES

  ~~~~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to force highlight.js to use a certain logic

+ This configuration key can be used to force highlight.js to use a certain logic

  on certain files based on their extensions.

  

  It should be a dictionary containing the file extensions as keys and
@@ -1703,7 +1703,7 @@ 

  

  Pagure can be integrated with `repoSpanner <https://repospanner.org>`_

  allowing to deploy pagure in a load-balanced environment since the git

- repositories are then synced accross multiple servers simultaneously.

+ repositories are then synced across multiple servers simultaneously.

  

  Support for this integration has been included in Pagure version 5.0 and higher.

  
@@ -1763,7 +1763,7 @@ 

  REPOSPANNER_REGIONS

  ~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to specify the different region where repoSpanner

+ This configuration key can be used to specify the different region where repoSpanner

  is deployed and thus with which this pagure instance can be integrated.

  

  An example entry could look like:
@@ -1947,7 +1947,7 @@ 

  MQTT_TOPIC_PREFIX

  ~~~~~~~~~~~~~~~~~

  

- This configuration key allows to specify a prefix to the mqtt messages sent.

+ This configuration key can be used to specify a prefix to the mqtt messages sent.

  This prefix will be added to the topic used by pagure thus allowing the mqtt

  admins to specify a parent topic for all pagure-related messages.

  
@@ -1957,7 +1957,7 @@ 

  ALWAYS_MQTT_ON_COMMITS

  ~~~~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to enforce `mqtt <https://mqtt.org/>`_

+ This configuration key can be used to enforce `mqtt <https://mqtt.org/>`_

  notifications on commits made on all projects in a pagure instance.

  

  Defaults to: ``False``.
@@ -2013,7 +2013,7 @@ 

  FILE_SIZE_HIGHLIGHT

  ~~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to specify the maximum number of characters a file

+ This configuration key can be used to specify the maximum number of characters a file

  or diff should have to have syntax highlighting. Everything above this limit

  will not have syntax highlighting as this is a memory intensive procedure that

  easily leads to out of memory error on large files or diff.
@@ -2024,7 +2024,7 @@ 

  BOOTSTRAP_URLS_CSS

  ~~~~~~~~~~~~~~~~~~

  

- This configuration key allows to specify the URL where are hosted the bootstrap

+ This configuration key can be used to specify the URL where are hosted the bootstrap

  CSS file since the files hosted on apps.fedoraproject.org used in pagure.io

  are not restricted in browser access.

  
@@ -2037,7 +2037,7 @@ 

  BOOTSTRAP_URLS_JS

  ~~~~~~~~~~~~~~~~~

  

- This configuration key allows to specify the URL where are hosted the bootstrap

+ This configuration key can be used to specify the URL where are hosted the bootstrap

  JS file since the files hosted on apps.fedoraproject.org used in pagure.io

  are not restricted in browser access.

  

file modified
+1 -1
@@ -40,7 +40,7 @@ 

      (for ``failure`` vs ``error`` think of the test system ran the tests but

      they failed vs the test system did not get to run the tests)

  

- - **percent**: this is an optional field which allows to provide some more

+ - **percent**: this is an optional field which can be used to provide some more

    details about the outcome of the task. For example this could be used for

    test coverage, or the number of test that failed/passed.

  

@@ -11,7 +11,7 @@ 

  

  The principal is:

  * pagure will trigger a build on jenkins when a pull-request is created,

-   updated or when someone explicitely asks pagure to do so or when a new commit

+   updated or when someone explicitly asks pagure to do so or when a new commit

    is pushed (if pagure-ci is configured to trigger on commit).

  

  * pagure will send a few information to jenkins when triggering a build:

file modified
+1 -1
@@ -51,7 +51,7 @@ 

  --------------------------------------------

  

  Very much in the same way pagure allows you to filter for issues having a

- certain tag, pagure allows to filter for issues *not* having a certain tag.

+ certain tag, pagure allows one to filter for issues *not* having a certain tag.

  To do this, simply prepend a ``!`` in front of the tag.

  

  Example:

file modified
+1 -1
@@ -5,7 +5,7 @@ 

  Basically, pagure will make a HTTP POST request to one or more third party

  server/application with information about what is or just happened.

  

- Activating web-hooks notications

+ Activating web-hooks notifications

  --------------------------------

  

  To set-up a web-hook, simply go to the settings page of your project and

While packaging Pagure for Debian, lintian told me that there are a
few spelling errors in the documentation. This commit fixes them.

This seems to conflict now, I suspect because of the new release :(

rebased onto 55cebaf

4 years ago

I rebased it against the current master. Should be fine now. Thanks for the notice.

Pull-Request has been merged by pingou

4 years ago