diff --git a/doc/usage/first_steps.rst b/doc/usage/first_steps.rst index 00de2c2..8a4f3d4 100644 --- a/doc/usage/first_steps.rst +++ b/doc/usage/first_steps.rst @@ -67,7 +67,7 @@ the top right corner, there, select ``My settings``. .. image:: _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 +.. note:: Pagure supports multiple ssh keys per user. To add more than one ssh key to your user account just add your new ssh key in your authentication settings (one key per row), this way you will be able to push commits to your repository from a different computer. diff --git a/doc/usage/flags.rst b/doc/usage/flags.rst index 0cf724d..ddf075b 100644 --- a/doc/usage/flags.rst +++ b/doc/usage/flags.rst @@ -15,7 +15,7 @@ lint tool, or test coverage evolution. Add a flag ---------- -Flags can be set via the API, see the ``/api/`` url in your pagure instance +Flags can be set via the API, see the ``/api/`` URL in your pagure instance or at `pagure.io/api/ `_ and look for the endpoints with the titles: ``Flag a commit`` or ``Flag a pull-request``. @@ -50,7 +50,7 @@ with the titles: ``Flag a commit`` or ``Flag a pull-request``. - **comment**: a free text form not restricted in length (however, here as well if the comment is too long it may render off in the interface). -- **url**: the url the flag is linked to and where the user should be able +- **url**: the URL the flag is linked to and where the user should be able to retrieve more information about the task and its outcome. diff --git a/doc/usage/markdown.rst b/doc/usage/markdown.rst index eab4a03..ddad6c5 100644 --- a/doc/usage/markdown.rst +++ b/doc/usage/markdown.rst @@ -10,26 +10,26 @@ formatting. This help page helps demonstrate how to use Markdown in Pagure. Pagure relies on the `Markdown `_ python -module to do the convertion. +module to do the conversion. It has enabled a few extensions: -- `Definition Lists `_ -- `Fenced Code Blocks `_ -- `Tables `_ -- `Smart Strong `_ -- `Admonition `_ -- `CodeHilite `_ -- `Sane lists `_ +- `Definition Lists `_ +- `Fenced Code Blocks `_ +- `Tables `_ +- `Smart Strong `_ +- `Admonition `_ +- `CodeHilite `_ +- `Sane lists `_ README files can also rely on: -- `Abbreviations `_ -- `Footnotes `_ -- `Table of Contents `_ +- `Abbreviations `_ +- `Footnotes `_ +- `Table of Contents `_ While comments use: -- `New Line to Break `_ +- `New Line to Break `_ .. warning:: Pagure does not support linking to remote images, if you want @@ -237,7 +237,7 @@ Emoji Pagure natively supports emoji characters. To use emoji, you can use two colons wrapped around the emoji keyword (`:emoji:`). Typing a colon by itself will bring up a list of suggested emoji with a small preview. If you see the -one you're looking for, you can click it to automatically complete the emoji. +one you are looking for, you can click it to automatically complete the emoji. `I reviewed the PR and it looks good to me. :+1: Good to merge! :clapper:` diff --git a/doc/usage/pagure_ci_jenkins.rst b/doc/usage/pagure_ci_jenkins.rst index 10a9a98..3922be8 100644 --- a/doc/usage/pagure_ci_jenkins.rst +++ b/doc/usage/pagure_ci_jenkins.rst @@ -18,7 +18,7 @@ How to enable Pagure CI * Enter the URL to the project on the CI service. For example, if your project is running at `http://jenkins.fedoraproject.org` you will need to - enter the url: `http://jenkins.fedoraproject.org/job/` + enter the URL: `http://jenkins.fedoraproject.org/job/` * Tick the checkbox activating the hook. diff --git a/doc/usage/project_acls.rst b/doc/usage/project_acls.rst index d027a6f..283a842 100644 --- a/doc/usage/project_acls.rst +++ b/doc/usage/project_acls.rst @@ -30,7 +30,7 @@ With Project ACL feature, We can now have three levels of access: They can change the settings of the project, add/remove users/groups on the project. Add/Update Access -================= +----------------- * Every time you add a new user or a new group to the project, you will be asked to provide the level of access you want to give to that user or group. It's a required @@ -48,7 +48,7 @@ Add/Update Access click on Update button. Points to be noted -================== +------------------ * The creator of a project in pagure holds a more unique position than a normal user with admin access. The creator can not be removed by an admin. His access level diff --git a/doc/usage/project_settings.rst b/doc/usage/project_settings.rst index 6518ae0..a2a08ec 100644 --- a/doc/usage/project_settings.rst +++ b/doc/usage/project_settings.rst @@ -11,7 +11,7 @@ This page presents the different settings and there effect. `Activate always merge` ------------------------ -This boolean enables or disables always making a merge commit when merging +This Boolean enables or disables always making a merge commit when merging a pull-request. When merging a pull-request in pagure there are three states: @@ -33,7 +33,7 @@ above is disabled in favor of the `merge` option. `Activate comment editing` -------------------------- -This boolean enables or disables editing comments. +This Boolean enables or disables editing comments. After commenting on a ticket or a pull-request, the admins of the project and the author of the comment may be allowed to edit the comment. @@ -49,7 +49,7 @@ and this setting allows turning it on or off. `Activate Enforce signed-off commits in pull-request` ----------------------------------------------------- -This boolean enables or disables checking for a 'Signed-off-by' line (case +This Boolean enables or disables checking for a 'Signed-off-by' line (case insensitive) in the commit messages of the pull-requests. If this line is missing, pagure will display a message near the `Merge` @@ -62,7 +62,7 @@ button, allowing project admin to request the PR to be updated. `Activate issue tracker` ------------------------ -This boolean simply enables or disables the issue tracker for the project. +This Boolean simply enables or disables the issue tracker for the project. So if you are tracking your ticket on a different system, you can simply disable reporting issue on pagure by un-checking this option. @@ -78,7 +78,7 @@ and the sum of the votes in favor minus the sum of the votes against give the pull-request a score that should be equal or greater than the value entered in this option for the pull-request to be allowed to be merged. -.. note:: Only the main comments (ie: not in-line) are taken into account +.. note:: Only the main comments (i.e.: not in-line) are taken into account to calculate the score of the pull-request. To vote in favor of a pull-request, use either: @@ -126,7 +126,7 @@ the developer to merge these changes into the project. This is similar to the pull-request mechanism on GitHub or GitLab. However, some projects may prefer receiving patches by email on their list -or via another hosting plateform or simply do not wish to use the +or via another hosting platform or simply do not wish to use the pull-request mechanism at all. Un-checking this option will therefore prevent anyone from opening a pull-request against this project. diff --git a/doc/usage/pull_requests.rst b/doc/usage/pull_requests.rst index 37bbd23..c8f247c 100644 --- a/doc/usage/pull_requests.rst +++ b/doc/usage/pull_requests.rst @@ -65,7 +65,7 @@ From the pull requests list Remote Git to Pagure pull request ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -You can create a pull request from an other git hosting platform (eg github, gitlab). +You can create a pull request from another git hosting platform (e.g. GitHub, GitLab). This is a remote pull request. From the pull requests list @@ -125,7 +125,7 @@ to that section as **the first fetch line**, like this:: fetch = +refs/pull/*/head:refs/remotes/origin/pr/* fetch = +refs/heads/*:refs/remotes/origin/* -Obviously, the remote url should be matching the url of your project (pagure project in +Obviously, the remote URL should be matching the URL of your project (pagure project in this example). Now you can fetch the all the pull requests: :: diff --git a/doc/usage/read_only.rst b/doc/usage/read_only.rst index 110300e..f095f53 100644 --- a/doc/usage/read_only.rst +++ b/doc/usage/read_only.rst @@ -24,7 +24,7 @@ for ssh based git usage. Actions that put the project in read only mode -============================================== +---------------------------------------------- All the actions that needs gitolite to be compiled, will bring the project in read only mode. diff --git a/doc/usage/theming.rst b/doc/usage/theming.rst index f44d9ce..ec98e87 100644 --- a/doc/usage/theming.rst +++ b/doc/usage/theming.rst @@ -47,7 +47,7 @@ from. So what you want to do is replace this ``master.html`` by your own. cp /path/to/original/pagure/templates/master.html /var/www/mypaguretheme/templates -* Edit it and replace the url pointing to the pagure logo (around line 27) +* Edit it and replace the URL pointing to the pagure logo (around line 27) :: @@ -72,12 +72,12 @@ In production ------------- Serving static files via flask is fine for development but in production -you will probably want to have apache server them. This will allow caching +you will probably want to have Apache serve them. This will allow caching either on the server side or on the client side. -You can ask apache to behave in a similar way as does flask-multistatic with -flask here, ie: search in one folder and if you don't find the file look +You can ask Apache to behave in a similar way as does flask-multistatic with +flask here, i.e.: search in one folder and if you don't find the file look in another one. -`An example apache configuration `_ +`An example Apache configuration `_ is provided as part of the sources of `flask-multistatic`_. diff --git a/doc/usage/tips_tricks.rst b/doc/usage/tips_tricks.rst index 3cf1ecd..831376a 100644 --- a/doc/usage/tips_tricks.rst +++ b/doc/usage/tips_tricks.rst @@ -8,8 +8,8 @@ fit in their own page but are worth mentioning. Pre-fill issue template using the URL ------------------------------------- -When Creating Issues for a project , Pagure supports pre-filling the title -and description input text using url parameters +When creating issues for a project pagure supports pre-filling the title +and description input text using URL parameters. Example: ~~~~~~~~ @@ -48,7 +48,7 @@ When watching a user's page, the list of all the project that user is involved in is presented regardless of whether the user has ticket, commit, admin access or is the main admin of the project. -You can specify an ``acl=`` argument to the url to filter the list of +You can specify an ``acl=`` argument to the URL to filter the list of projects by access.