From 29f4134f7daf34174a14e230788fc3fd22f6c1e2 Mon Sep 17 00:00:00 2001 From: four_4 Date: Oct 29 2022 01:44:26 +0000 Subject: [PATCH 1/2] Merge of docs between mirrored fork and main fork --- diff --git a/doc/changelog.rst b/doc/changelog.rst index 0b5e658..5a39a3c 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -20,7 +20,7 @@ This document records all notable changes to `Pagure `_. 5.13.0 (2021-01-19) ------------------- -- When failing to find a git repo, log where pagure looked +- When failing to find a git repo, log where Pagure looked - Get the default branch of the target repo when linking for new PR - Add an hascommit API endpoint - Fixing sample input and output for alias related api (Mohan Boddu) @@ -55,7 +55,7 @@ pull-request. - Allow using the modifyacl API endpoint to remove groups from a project - Add a note that repo_from* argument are mandatory in some situations when opening a Pull-Request from the API -- Increase the list of running pagure instances in the documentation (Neal Gompa) +- Increase the list of running Pagure instances in the documentation (Neal Gompa) - Remove fenced code block when checking mention (Michael Scherer) - Add support for using cchardet to detect files' encoding - Show the default branch in the project overview page @@ -145,11 +145,11 @@ pull-request. - Add support for customizing the new issue page - Introducing the boards feature - Add an API endpoint to view the content of a git repo -- Port pagure's markdown extension to the new API +- Port Pagure's markdown extension to the new API - Multiple small fixes for the vagrant-based development environment - Use WhiteNoise to serve static assets for the Pagure web - Fix running the tests on py 3.8 -- Port pagure's test suite to pytest +- Port Pagure's test suite to pytest - Fix the title of the graph showing the evolution of the number of open tickets on a project - Do not assume there is a SMTP_STARTTLS configuration key set @@ -173,14 +173,14 @@ pull-request. - Allow viewing issues via the API using project-less API token (Julen Landa Alustiza) - Rename Koshei to Koschei in the srcfpo theme (Fabio Valentini) -- Make pagure work with recent sqlalchemy versions (>= 1.3.0) -- Improve the vagrant-based dev environment for pagure developers +- Make Pagure work with recent sqlalchemy versions (>= 1.3.0) +- Improve the vagrant-based dev environment for Pagure developers - Add a new API endpoint to retrieve detailed stats about the issues - Improve the graphs displayed in the stats tab of each projects - Remove dependency on d3.js - Add dependency on chartjs - Add a new graph tracking the number of open issues throughout the year -- Upgrade the container based development environment for pagure developers +- Upgrade the container based development environment for Pagure developers (Andrew Engelbrecht) - Improve loading tickets from git - Support pygit2 >= 1.1.0 (Andrew Engelbrecht) @@ -204,13 +204,13 @@ pull-request. - Improve email text for new user registration (zPlus) - Set the USER environment variable when pushing over http - Add support for git push via http using basic auth relying on API token -- If pagure is set up for local auth, allow git push via https to use it -- Add an example nginx configuration file for pagure (Neal Gompa) -- Create two subpackages in the pagure for the apache and nginx configuration +- If Pagure is set up for local auth, allow git push via https to use it +- Add an example nginx configuration file for Pagure (Neal Gompa) +- Create two subpackages in the Pagure for the apache and nginx configuration files (Neal Gompa) -- Add some documentation on how git push over http works in pagure -- Make pagure compatible with the latest version of flake8 -- Add PAGURE_PLUGINS_CONFIG setting in pagure configuration file (zPlus) +- Add some documentation on how git push over http works in Pagure +- Make Pagure compatible with the latest version of flake8 +- Add PAGURE_PLUGINS_CONFIG setting in Pagure configuration file (zPlus) 5.9.1 (2020-03-30) @@ -410,7 +410,7 @@ pull-request. Alustiza) - Document the git auth backend `pagure` (mrx@mailinator.com) - Catch ImportError before trying to catch any fedora_messaging exceptions -- pagure markdown extension: encapsulate our markdowns on a div tag (Julen Landa +- Pagure markdown extension: encapsulate our markdowns on a div tag (Julen Landa Alustiza) - Add styling for markdown tables (Julen Landa Alustiza) - Always notify the person who opened the ticket/PR or are assigned to it @@ -431,7 +431,7 @@ pull-request. - Include a small introduction text to email on loading files - Move the side-bar of the repo_master into its own template for easier overriding by other themes -- Enforce black on all pagure, including tests, docs and all +- Enforce black on all Pagure, including tests, docs and all - Add an option to pagure-admin to delete a project - Add an option to pagure-admin block-user to list the users blocked - Ensure "No activity" rows get removed on subsequent updates of the calendar @@ -439,7 +439,7 @@ pull-request. - Send a notification upon editing the initial comment of a PR - Send notifications on tag creation and tag and branch deletion - Comment reply button: remove icon title (Frank Dana) -- Fix updating project options when running pagure in python 2 +- Fix updating project options when running Pagure in python 2 - Fix the test button for webhook notifications - Fix opening PR on forks on the page listing the PRs - Add repo_from argument for API create pull request (Lenka Segura) @@ -551,7 +551,7 @@ pull-request. - Fix repoSpanner integration (Patrick Uiterwijk) - Make sure repoSpanner tests run in CentOS CI (Patrick Uiterwijk) - Only block new branches in hooks (Lubomír Sedlář) -- Add support for fedora-messaging in pagure +- Add support for fedora-messaging in Pagure - Fix calculation of days until API key expires in the emails (Karsten Hopp) - Move to container-based testing on jenkins testing the following environment - F29 using python3 with dependencies installed as RPMs @@ -574,7 +574,7 @@ pull-request. - Add support for the MQTT protocol (jingjing) - Add support for mirroring in git repositories from outside sources - Add the possibility to give a group away -- Port pagure to markdown 3.0+ while remaining backward compatible +- Port Pagure to markdown 3.0+ while remaining backward compatible - Add support to merge a PR when the fork was deleted - Indicate that the file can be either empty or a binary file in diffs - Add the API endpoint to create new PR in the API doc @@ -604,7 +604,7 @@ pull-request. - Allow commenting on a PR when clicking on the merge button - Include whether the PR passed the threshold or not in the API data - Change the way votes are recorded on PRs -- Add support for third-party extensions to pagure (this is very much +- Add support for third-party extensions to Pagure (this is very much work in progress and might/will fluctuate as it is polished - Do Not Consider This Stable) - Enable token authentication on internal endpoints (Slavek Kabrda) @@ -741,7 +741,7 @@ pull-request. - Add to theme the possibility to display site-wide messages (Ryan Lerch) - Multiple adjustments to the scripts keyhelper and aclchecker (Patrick Uiterwijk) - Only enforce Signed-Off-By on the main git repo -- Ignore any and all action done by the pagure user when loading JSON into the db +- Ignore any and all action done by the Pagure user when loading JSON into the db - Fix the last modified date on the PR list - Updating regex for URLs and SSH urls - Use gitolite's own mechanism to bypass the update hook @@ -894,12 +894,12 @@ pull-request. 4.0 (2018-04-26) ---------------- -- Re-architecture the project to allow potentially extending pagure outside of +- Re-architecture the project to allow potentially extending Pagure outside of its core - Fix running the tests on newer pygit - Add a space between the fork and the watch buttons - Add a global configuration option to turn on or off fedmsg notifications for - the entire pagure instance + the entire Pagure instance - Set the default username to be 'Pagure' when sending git commit notifications by email - Add project setting to show roadmap by default (Vivek Anand) @@ -907,7 +907,7 @@ pull-request. - Expand and document the tokenization search - Add document that multiple keys are supported - Add a way to block non fast-forwardable commits on all branches -- Fix running pagure on docker for development (Clément Verna) +- Fix running Pagure on docker for development (Clément Verna) - Make the accordeon in the settings page work correctly - Allow calling git blame on a commit instead of a branch - Exclude the .pyc files from all folders @@ -971,7 +971,7 @@ pull-request. - Specify which service is logging the action for easier debugging/reading of the logs - Merge the fedmsg notifications on commit logic into the default hook -- Merge pagure-ci into the pagure's celery-based services +- Merge pagure-ci into the Pagure's celery-based services - When creating a new PR, allow updating the branch from - Allow pull changes from a different repo than the parent one - Add a new internal endpoint to get the family of a project @@ -1016,7 +1016,7 @@ pull-request. web-hook - Fix supporting branches containing multiple dots - Do not convert to markdown commit messages in notifications -- Port pagure to use the compile-1 script from upstream gitolite (if +- Port Pagure to use the compile-1 script from upstream gitolite (if configured to do so) (Slavek Kabrda) - Add preview when editing a comment (Rahul Bajaj) and the initial comment - Ensure that deployment keys are managed correctly (Michael Watters) @@ -1087,7 +1087,7 @@ pull-request. - Fix the doc about custom gitolite config - Fix displaying the filename on the side and linking to file for remote PRs - Add irc info in Readme (Vivek Anand) -- Make pagure compatible with newer python chardet +- Make Pagure compatible with newer python chardet - Check that the identifier isn't the hash of a git tree in view_file - Fix if the identifier provided is one of a blob instead of a commit in view_commit @@ -1131,7 +1131,7 @@ pull-request. - Add a default_priority field to projects - Bail on merge a PR that is already closed - Add a graph of the history of the open issues on the project -- Make the pagure hook act as the person doing the push +- Make the Pagure hook act as the person doing the push - Clean spec file to drop deprecated lines and macros (Igor Gnatenko) - Include selectize in the settings page to fix the autocomplete in the give project action @@ -1172,7 +1172,7 @@ pull-request. - Add a button and an API endpoint to subscribe to PR's notifications - Fix showing the file names in PR (pre)view - Fix number of typos in the documentation (René Genz) -- Improve the documentation about documentation hosting in pagure (René Genz) +- Improve the documentation about documentation hosting in Pagure (René Genz) - Allow priorities and milestones to be 0 or -1 - Return the flag UID when adding or updating a flag on a PR not in fedmsg - Add flags on commits @@ -1199,7 +1199,7 @@ pull-request. - Show the branches' head in the commit list - Log which IP is being denied access to the internal endpoints (makes debugging easier) -- Link to pagure's own markdown documentation and warn that remote images are +- Link to Pagure's own markdown documentation and warn that remote images are not supported - Document how to run a single test file or a single test in a file - Fix trying to decode when the encoding is None @@ -1250,7 +1250,7 @@ pull-request. - Allow viewing a PR when its origin (fork or branch) is gone - Fix linking to issue or PR in namespaced projects via # - Make it more obvious that the namespace and the project are different links -- Tell fedmsg to send things with pagure certificates (Patrick Uiterwijk) +- Tell fedmsg to send things with Pagure certificates (Patrick Uiterwijk) - Fix loading ticket templates on namespaced project and extracting their names - Add a banner on the overview page when the ACLs are being refreshed on the backend (and thus ssh access may not be entirely functional) (Vivek Anand) @@ -1259,7 +1259,7 @@ pull-request. - Add the possibility to get the group members when asking the project info - Make the PROJECT_NAME_REGEX used in form be configurable - Adjust the milter to support replying with any email addresses associated -- Allow pagure admin to give a project +- Allow Pagure admin to give a project 3.7.1 (2017-09-05) @@ -1337,7 +1337,7 @@ pull-request. project (Vivek Anand) - Update the refresh-gitolite action of pagure-admin for the new interface (turns out this wasn't in fact merged in 3.4) -- Add a configuration key to make pagure case sensitive +- Add a configuration key to make Pagure case sensitive - Add an USER_ACLS configuration key - Document the different API token ACLs configuration keys - Fix syncing groups from external account sources (Patrick Uiterwijk) @@ -1351,14 +1351,14 @@ pull-request. - Fix logging by properly formatting the message - Fix the issue count in the My Issues page (Vivek Anand) - Add a configuration key to disable deleting branches from the UI -- Add a configuration key to disable managing user's ssh key in pagure +- Add a configuration key to disable managing user's ssh key in Pagure - Fix the vagrant environment (Clement Verna) - Fix branch support for the git blame view - Update the PR ref when the PR is updated -- Add a configuration key to disable the deploy keys in a pagure instance -- Fix login when groups are managed outside of pagure +- Add a configuration key to disable the deploy keys in a Pagure instance +- Fix login when groups are managed outside of Pagure - Fix setting up the git hooks when there is no DOCS_FOLDER set -- Fix installing up the pagure hooks when there is no DOCS_FOLDER set +- Fix installing up the Pagure hooks when there is no DOCS_FOLDER set 3.3.1 (2017-07-24) @@ -1414,11 +1414,11 @@ pull-request. ---------------- - Since 2.90 celery has become a requirement as well as one of the queueing - system it supports (pagure defaults to using redis) + system it supports (Pagure defaults to using redis) - Multiple stability and performance improvements (mainly thanks to Patrick Uiterwijk) - Fix the assignee value in fedmsg when assigning a ticket (Ricky Elrod) -- Make pagure support bleach 2.0.0 (Shengjing Zhu) +- Make Pagure support bleach 2.0.0 (Shengjing Zhu) - Fixes in CI support (Tim Flink) - Update the documentation - Fix plain readme html escape (Shengjing Zhu) @@ -1449,7 +1449,7 @@ pull-request. - Fix diffing the branch of a project against the target branch - Fix displaying the new PR button on the default branch - Do not send a notification upon merge conflicts -- Do not let pagure return 500 when hit with bogus URL +- Do not let Pagure return 500 when hit with bogus URL - When loading comment from JSON rely on username/comment rather than comment id - When deleting a comment, refresh the ticket git repo - Make patch_to_diff use lists instead of string concatenation (Patrick @@ -1651,7 +1651,7 @@ pull-request. - Allow filtering issues for certain custom keys using : in the search input (Patric Uiterwijk) - Make loading the JSON blob into the database its own async service -- Add ACLs to pagure (Vivek Anand) +- Add ACLs to Pagure (Vivek Anand) - Fix running the tests against postgresql - Let the doc server return the content as is when it fails to decode it - Fix rendering a issue when one of the custom fields has not been properly @@ -1707,7 +1707,7 @@ pull-request. - Do not edit multiple times the milestone info when updating a ticket - Only update the custom field if there is a value to give it, otherwise remote it -- Make pagure compatible with flask-wtf >= 0.14.0 +- Make Pagure compatible with flask-wtf >= 0.14.0 - Add a button to test web-hook notifications - Fix the layout on the page listing all the closed issues (Rahul Bajaj) - Load priorities when refreshing the DB from the ticket git repos (Mark @@ -1763,7 +1763,7 @@ pull-request. (Clement Verna) - Add a button to create a default set of close status (as we have a default set of priorities) -- Have pagure bail with an error message if the OpenID server did not return an +- Have Pagure bail with an error message if the OpenID server did not return an username - Let the error email use the FROM_EMAIL address set in the configuration file - Fix theprogress bar shown when listing issues (Gaurav Kumar) @@ -1796,7 +1796,7 @@ pull-request. - Update API doc for api_view_user (Clement Verna) - 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 +- 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 - Add a type list to the custom fields (allows restricting the options) (Mark Reynolds) @@ -1850,7 +1850,7 @@ pull-request. - Adjust the markdown processor to have 1 regex for all cross-project links - 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 +- Show user activity in Pagure on the user's page - Add the possibility to subscribe to issues - Do not cache the session in pagure-ci (as we did for pagure-webhook) - Fix rendering raw file when the sha1 provided is one of a blob @@ -1882,7 +1882,7 @@ pull-request. - Fix handling namespaced project in the SSE server (Adam Williamson) - Add a pylintrc configuration file to help with code standards (Adam Williamson) -- Add go-import meta tag allowing go projects to be hosted on pagure (Patrick +- Add go-import meta tag allowing go projects to be hosted on Pagure (Patrick Uiterwijk) - Fix index overflow when opening remote pull-request (Mark Reynolds) - Add SSE support for custom fields @@ -1976,7 +1976,7 @@ pull-request. pull-request - Fix the progress bar on the page listing the issues (d3prof3t) - Do not call the API when viewing a diff or a PR if issues or PRs are disabled -- Port pagure to flask 0.13+ +- Port Pagure to flask 0.13+ - Fix displaying the reason when a PR cannot be merged - Allow projects to turn on/off fedmsg notifications - Fix the web-hook service so when a project is updated the service is as well @@ -1987,7 +1987,7 @@ pull-request. Cline) - Use long dash in footer instead of two short ones (Lubomír Sedlář) - Add a welcome screen to new comers (does not work with local auth) -- Ensure user are not logged in if we couldn't properly set them up in pagure +- Ensure user are not logged in if we couldn't properly set them up in Pagure - Add the possibility to search through issues (AnjaliPardeshi) - Add a default hook to all new projects, this hook re-set the merge status of all the open PR upon push to the main branch of the repo @@ -2015,7 +2015,7 @@ pull-request. - Add the possibility for projects to notify specific email addresses about issues/PRs update - Fix loading tickets from the ticket git repository (fixes importing project to - pagure) + Pagure) 2.5 (2016-09-13) @@ -2057,7 +2057,7 @@ pull-request. - [Security] Avoid all html related mimetypes and force the download if any (CVE-2016-1000037) -- Fixed in 2.3.4 as well - Redirect the URL to projects .git to (Abhishek Goswami) -- Allow creating projects with 40 chars length name on newer pagure instances +- Allow creating projects with 40 chars length name on newer Pagure instances - Fix @ and # when editing a comment (Eric Barbour) - Display properly and nicely the ACLs of the API tokens (Lubomír Sedlář) - Removing html5lib so bleach installation finds what version is best (Tiago M. @@ -2065,7 +2065,7 @@ pull-request. - Remove the branchchooser from the repoheader (again) (Ryan Lerch) - Fix hard-coded urls in the master template - Made the interaction with the watch button clearer (Ryan Lerch) -- Introduce pagure-ci, a service allowing to integrate pagure with a jenkins +- Introduce pagure-ci, a service allowing to integrate Pagure with a jenkins instance (Farhaan Bukhsh and I) - Accept Close{,s,d} in the same way as Merges and Fixes (Patrick Uiterwijk) - Avoid showing the 'New PR' button on the overview page is a PR already exists @@ -2073,7 +2073,7 @@ pull-request. - Fix presenting the readme file and display the readme in the tree page if there is one in the folder displayed (Ryan Lerch) - Move the new issue button to be available on every page (AnjaliPardeshi) -- Fix pagure for when an user enters a comment containing # where the id +- Fix Pagure for when an user enters a comment containing # where the id isn't found in the db - Make the bootstrap URLs configurable (so that they don't necessarily point to the Fedora infra) (Farhaan Bukhsh) @@ -2083,7 +2083,7 @@ pull-request. - Improve the load_from_disk utility script - Fix our mardown processor to avoid crashing on # (where we expect #) - Fix the search for projects with a / in their names -- Fix adding a file to a ticket when running pagure with `local` auth +- Fix adding a file to a ticket when running Pagure with `local` auth - Improve the grammar around the allowed prefix in our fake-namespaces (Jason Tibbitts) - Implement scanning of attached files for viruses (Patrick Uiterwijk) @@ -2168,9 +2168,9 @@ pull-request. - Fix the edit link when adding a comment to a ticket via SSE - Add notifications to issues as we have for pull-requests - Record in the db the date at which a ticket was closed (Vivek Anand) -- Add the possibility for pagure to rely on external groups provided by the auth +- Add the possibility for Pagure to rely on external groups provided by the auth service -- Add the possibility for pagure to use an SMTP server requiring auth +- Add the possibility for Pagure to use an SMTP server requiring auth (Vyacheslav Anzhiganov) - Add autocomple/suggestion on typing # for tickets and pull-requests (Eric Barbour) @@ -2254,14 +2254,14 @@ pull-request. - Rework installing and removing git hooks (Clement Verna) - Rework the summary of the changes on the PR page (Ryan Lerch) - Improve the description of the priority system (Lubomír Sedlář) -- Fix commit url in the pagure hook (Mike McLean) +- Fix commit url in the Pagure hook (Mike McLean) - Improve the regex when fixing/relating a commit to a ticket or a PR (Mike McLean) -- Improve the description of the pagure hook (Mike McLean) +- Improve the description of the Pagure hook (Mike McLean) - Fix the priority system to support tickets without priority - Fix the ordering of the priority in the drop-down list of priorities - Ensure the drop-down list of priorities defaults to the current priority -- Adjust the runserver.py script to setup PAGURE_CONFIG before importing pagure +- Adjust the runserver.py script to setup PAGURE_CONFIG before importing Pagure - Remove flashed message when creating a new project - Add markdown support for making of PR# a link to the corresponding PR - Include the priority in the JSON representation of a ticket @@ -2311,7 +2311,7 @@ pull-request. not) - Fix the pagination on the browse pages when the results are sorted - Disable the Commit and Files tabs if a repo is new -- Update the pagure logo to look better (Ryan Lerch) +- Update the Pagure logo to look better (Ryan Lerch) - Allow anyone to fork any project (Ryan Lerch) - Fix searching on the browse pages by preventing submission of the 'enter' key (Ryan Lerch) @@ -2342,7 +2342,7 @@ pull-request. Lerch) - 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 +- Allow reply to a notification of Pagure and setting the reply email address as Cc - In the fedmsg git hook, publish the username of all the users who authored the commits pushed @@ -2352,7 +2352,7 @@ pull-request. - Fix showing the list of branches when viewing a file - Add priorities to issues, with the possibility to filter or sort them by it in the page listing them. -- Add support for pseudo-namespace to pagure (ie: allow one '/' in project name +- Add support for pseudo-namespace to Pagure (ie: allow one '/' in project name with a limited set of prefix allowed) - Add a new plugin/hook to block push containing commits missing the 'Signed-off-by' line @@ -2361,7 +2361,7 @@ pull-request. - Add support for using the keyword Merge(s|d) to close a ticket or pull-request via a commit message (Patrick Uiterwijk) - Add an UPGRADING.rst documentation file explaining how to upgrade between - pagure releases + Pagure releases 1.2 (2016-03-01) @@ -2380,7 +2380,7 @@ pull-request. current logo (Ryan Lerch) - Drop the svg of the old logo from the source (Ryan Lerch) - Add descriptions to the git hooks in the settings page (farhaanbukhsh) -- Fix the pagure git hook +- Fix the Pagure git hook 1.1.1 (2016-02-24) diff --git a/doc/configuration.rst b/doc/configuration.rst index 8f74ebc..1dfad25 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -5,7 +5,7 @@ Pagure offers a wide varieties of options that must or can be used to adjust its behavior. All of these options can be edited or added to your configuration file. -If you have installed pagure, this configuration file is likely located in +If you have installed Pagure, this configuration file is likely located in ``/etc/pagure/pagure.cfg``. Otherwise, it will depend on your setup/deployment. @@ -13,7 +13,7 @@ setup/deployment. Must options ------------ -Here are the options you must set up in order to get pagure running. +Here are the options you must set up in order to get Pagure running. SECRET_KEY @@ -53,7 +53,7 @@ Defaults to ``sqlite:////var/tmp/pagure_dev.sqlite`` APP_URL ~~~~~~~ -This configuration key indicates the URL at which this pagure instance will be made available. +This configuration key indicates the URL at which this Pagure instance will be made available. Defaults to: ``http://localhost.localdomain/`` @@ -72,7 +72,7 @@ GIT_URL_SSH ~~~~~~~~~~~ This configuration key provides the information to the user on how to clone -the git repos hosted on pagure via `SSH `_. +the git repos hosted on Pagure via `SSH `_. The URL should end with a slash ``/``. @@ -90,7 +90,7 @@ GIT_URL_GIT ~~~~~~~~~~~ This configuration key provides the information to the user on how to clone -the git repos hosted on pagure anonymously. This access can be granted via +the git repos hosted on Pagure anonymously. This access can be granted via the ``git://`` or ``http(s)://`` protocols. The URL should end with a slash ``/``. @@ -114,7 +114,7 @@ Defaults to: ``'redis://%s' % APP.config['REDIS_HOST']`` Repo Directories ---------------- -Each project in pagure has 2 to 4 git repositories, depending on configuration +Each project in Pagure has 2 to 4 git repositories, depending on configuration of the Pagure instance (see below): - the main repo for the code @@ -124,7 +124,7 @@ of the Pagure instance (see below): There are then another 3 folders: one for specifying the locations of the forks, one for the remote git repo used for the remotes pull-requests (ie: those coming from -a project not hosted on this instance of pagure), and one for user-uploaded tarballs. +a project not hosted on this instance of Pagure), and one for user-uploaded tarballs. GIT_FOLDER @@ -149,8 +149,8 @@ REMOTE_GIT_FOLDER ~~~~~~~~~~~~~~~~~ This configuration key points to the folder where the remote git repos (ie: -not hosted on pagure) that someone used to open a pull-request against a -project hosted on pagure are stored. +not hosted on Pagure) that someone used to open a pull-request against a +project hosted on Pagure are stored. UPLOAD_FOLDER_PATH @@ -213,7 +213,7 @@ or MongoDB for storing shared session keys. FROM_EMAIL ~~~~~~~~~~ -This configuration key specifies the email address used by this pagure instance +This configuration key specifies the email address used by this Pagure instance when sending emails (notifications). Defaults to: ``pagure@localhost.localdomain`` @@ -222,7 +222,7 @@ Defaults to: ``pagure@localhost.localdomain`` DOMAIN_EMAIL_NOTIFICATIONS ~~~~~~~~~~~~~~~~~~~~~~~~~~ -This configuration key specifies the domain used by this pagure instance +This configuration key specifies the domain used by this Pagure instance when sending emails (notifications). More precisely, it is used when building the ``msg-id`` header of the emails sent. @@ -247,11 +247,11 @@ Git auth backends can either be static (like gitolite), where a file is generated when something changed and then used on login, or dynamic, where the actual ACLs are checked in a git hook before being applied. -By default pagure provides the following backends: +By default Pagure provides the following backends: - `test_auth`: simple debugging backend printing and returning the string ``Called GitAuthTestHelper.generate_acls()`` -- `gitolite2`: allows deploying pagure on the top of gitolite 2 -- `gitolite3`: allows deploying pagure on the top of gitolite 3 +- `gitolite2`: allows deploying Pagure on the top of gitolite 2 +- `gitolite3`: allows deploying Pagure on the top of gitolite 3 - `pagure`: Pagure git auth implementation (using keyhelper.py and aclchecker.py) that is used via sshd AuthorizedKeysCommand - `pagure_authorized_keys`: Pagure git auth implementation that writes to authorized_keys file @@ -384,21 +384,21 @@ GITOLITE_KEYDIR This configuration key points to the folder where gitolite stores and accesses the public SSH keys of all the user have access to the server. -Since pagure is the user interface, it is pagure that writes down the files +Since Pagure is the user interface, it is Pagure that writes down the files in this directory, effectively setting up the users to be able to use gitolite. GITOLITE_CONFIG ^^^^^^^^^^^^^^^ -This configuration key points to the gitolite.conf file where pagure writes +This configuration key points to the gitolite.conf file where Pagure writes the gitolite repository access configuration. GITOLITE_CELERY_QUEUE ^^^^^^^^^^^^^^^^^^^^^ -This configuration is useful for large pagure deployment where recompiling +This configuration is useful for large Pagure deployment where recompiling the gitolite config file can take a long time. By default the compilation of gitolite's configuration file is done by the pagure_worker, which spawns by default 4 concurrent workers. If it takes a while to recompile the @@ -478,7 +478,7 @@ EVENTSOURCE_SOURCE ~~~~~~~~~~~~~~~~~~ This configuration key indicates the URL at which the EventSource server is -available. If not defined, pagure will behave as if there are no EventSource +available. If not defined, Pagure will behave as if there are no EventSource server running. @@ -499,7 +499,7 @@ WEBHOOK ~~~~~~~ This configuration key allows turning on or off web-hooks notifications for -this pagure instance. +this Pagure instance. Defaults to: ``False``. @@ -555,7 +555,7 @@ PAGURE_ADMIN_USERS List of local users that are the site admins. These admins have the same rights as the users in the admin groups listed above as well as admin rights to -all projects hosted on this pagure instance. +all projects hosted on this Pagure instance. Celery Queue options @@ -663,7 +663,7 @@ ALWAYS_STOMP_ON_COMMITS ~~~~~~~~~~~~~~~~~~~~~~~ This configuration key can be used to enforce `stomp `_ -notifications on commits made on all projects in a pagure instance. +notifications on commits made on all projects in a Pagure instance. Defaults to: ``False``. @@ -729,8 +729,8 @@ For more information about theming see the :doc:`usage/theming` Default options: -- ``chameleon`` The OpenSUSE theme for pagure -- ``default`` The default theme for pagure +- ``chameleon`` The OpenSUSE theme for Pagure +- ``default`` The default theme for Pagure - ``pagureio`` The theme used at https://pagure.io - ``srcfpo`` The theme used at https://src.fedoraproject.org @@ -797,7 +797,7 @@ Defaults to: "style-src 'self' 'nonce-{nonce}'" ) -Where ``{nonce}`` is dynamically set by pagure. +Where ``{nonce}`` is dynamically set by Pagure. LOGGING_GIT_HOOKS @@ -906,7 +906,7 @@ The default value is: .. note:: as you can see there is an ``email`` handler defined. It's not used anywhere by default but you can use it to get report of errors by email - and thus monitor your pagure instance. + and thus monitor your Pagure instance. To do this the easiest is to set, on the ``root`` logger: :: @@ -930,7 +930,7 @@ The default value is: This snippet will automatically make the logs rotate at midnight each day, keep the logs for 10 days and use UTC as timezone for the logs. Depending on - how your pagure instance is set-up, you may have to tweak the filesystem + how your Pagure instance is set-up, you may have to tweak the filesystem permissions on the folder and file so the rotation works properly. @@ -960,9 +960,9 @@ Defaults to: ``False``. SSH_ACCESS_GROUPS ~~~~~~~~~~~~~~~~~ -Some instances of pagure are deployed in such a way that only the members of +Some instances of Pagure are deployed in such a way that only the members of certain groups are allowed to commit via ssh. This configuration key allows -to specify which groups have commit access and thus let pagure hide the ssh +to specify which groups have commit access and thus let Pagure hide the ssh URL from the drop-down "Clone" menu for all the person who are not in one of these groups. If this configuration key is not defined or left empty, it is assume that there @@ -1011,7 +1011,7 @@ Defaults to: ``False`` SMTP_STARTTLS ^^^^^^^^^^^^^ -This configuration key specifies instructs pagure to starts connecting to +This configuration key specifies instructs Pagure to starts connecting to the SMTP server via a `starttls` command. When enabling STARTTLS in conjunction with a local smtp server, you should @@ -1116,7 +1116,7 @@ Valid options are ``fas``, ``openid``, ``oidc``, or ``local``. * ``oidc`` enables OpenID Connect using any provider. This provider requires the configuration options starting with ``OIDC_`` (see below) to be provided. -* ``local`` causes pagure to use the local pagure database for user management. +* ``local`` causes Pagure to use the local Pagure database for user management. User registration can be disabled with the ALLOW_USER_REGISTRATION configuration key. Defaults to: ``local``. @@ -1208,7 +1208,7 @@ MAX_CONTENT_LENGTH ~~~~~~~~~~~~~~~~~~ This configuration key specifies the maximum file size allowed when -uploading content to pagure (for example, screenshots to a ticket). +uploading content to Pagure (for example, screenshots to a ticket). Defaults to: ``4 * 1024 * 1024`` which corresponds to 4 megabytes. @@ -1217,7 +1217,7 @@ ENABLE_TICKETS ~~~~~~~~~~~~~~ This configuration key activates or deactivates the ticketing system -for all the projects hosted on this pagure instance. +for all the projects hosted on this Pagure instance. Defaults to: ``True`` @@ -1227,7 +1227,7 @@ ENABLE_TICKETS_NAMESPACE 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 +So if your Pagure instance has ``ENABLE_TICKETS`` as ``True`` and sets ``ENABLE_TICKETS_NAMESPACE`` to ``['tests', 'infra']`` only the projects opened in these two namespaces will have the ticketing system enabled. All the other namespaces will not. @@ -1240,7 +1240,7 @@ ENABLE_DOCS ~~~~~~~~~~~ This configuration key activates or deactivates creation of git repos -for documentation for all the projects hosted on this pagure instance. +for documentation for all the projects hosted on this Pagure instance. Defaults to: ``True`` @@ -1249,7 +1249,7 @@ ENABLE_NEW_PROJECTS ~~~~~~~~~~~~~~~~~~~ This configuration key permits or forbids creation of new projects via -the user interface and the API of this pagure instance. +the user interface and the API of this Pagure instance. Defaults to: ``True`` @@ -1258,7 +1258,7 @@ ENABLE_UI_NEW_PROJECTS ~~~~~~~~~~~~~~~~~~~~~~ This configuration key permits or forbids creation of new projects via -the user interface (only) of this pagure instance. It allows forbidding +the user interface (only) of this Pagure instance. It allows forbidding to create new project in the user interface while letting a set of trusted person to create projects via the API granted they have the API token with the corresponding ACL. @@ -1270,7 +1270,7 @@ ENABLE_DEL_PROJECTS ~~~~~~~~~~~~~~~~~~~ This configuration key permits or forbids deletion of projects via -the user interface of this pagure instance. +the user interface of this Pagure instance. Defaults to: ``True`` @@ -1279,7 +1279,7 @@ ENABLE_DEL_FORKS ~~~~~~~~~~~~~~~~ This configuration key permits or forbids deletion of forks via -the user interface of this pagure instance. +the user interface of this Pagure instance. Defaults to: ``ENABLE_DEL_PROJECTS`` @@ -1289,12 +1289,12 @@ GIT_HOOK_DB_RO This configuration key specifies if the git hook have a read-only (RO) access to the database or not. -Some pagure deployment provide an actual shell account on the host and thus the +Some Pagure deployment provide an actual shell account on the host and thus the git hook called upon git push are executed under that account. If the user manages to by-pass git and is able to access the configuration file, they could have access to "private" information. So in those deployments the git hooks have a specific configuration file with a database access that is read-only, -making pagure behave differently in those situations. +making Pagure behave differently in those situations. Defaults to: ``False`` @@ -1303,8 +1303,8 @@ EMAIL_SEND ~~~~~~~~~~ This configuration key enables or disables all email notifications for -this pagure instance. This can be useful to turn off when developing on -pagure, or for test or pre-production instances. +this Pagure instance. This can be useful to turn off when developing on +Pagure, or for test or pre-production instances. Defaults to: ``False``. @@ -1334,7 +1334,7 @@ ALWAYS_FEDMSG_ON_COMMITS ~~~~~~~~~~~~~~~~~~~~~~~~ This configuration key can be used to enforce `fedmsg `_ -notifications on commits made on all projects in a pagure instance. +notifications on commits made on all projects in a Pagure instance. Defaults to: ``True``. @@ -1343,7 +1343,7 @@ ALLOW_DELETE_BRANCH ~~~~~~~~~~~~~~~~~~~ This configuration keys enables or disables allowing users to delete git -branches from the user interface. In sensible pagure instance you may +branches from the user interface. In sensible Pagure instance you may want to turn this off and with a customized gitolite configuration you can prevent users from deleting branches in their git repositories. @@ -1372,9 +1372,9 @@ Defaults to: ``[]``. LOCAL_SSH_KEY ~~~~~~~~~~~~~ -This configuration key can be used 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. +In most cases, it will be fine to let Pagure handle it. Defaults to ``True``. @@ -1383,7 +1383,7 @@ DEPLOY_KEY ~~~~~~~~~~ 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 +entire Pagure instance. This feature enable to add extra public ssh keys that a third party could use to push to a project. Defaults to ``True``. @@ -1392,16 +1392,16 @@ Defaults to ``True``. OLD_VIEW_COMMIT_ENABLED ~~~~~~~~~~~~~~~~~~~~~~~ -In version 1.3, pagure changed its URL scheme to view the commit of a +In version 1.3, Pagure changed its URL scheme to view the commit of a project in order to add support for pseudo-namespaced projects. -For pagure instances older than 1.3, who care about backward compatibility, +For Pagure instances older than 1.3, who care about backward compatibility, we added an endpoint ``view_commit_old`` that brings URL backward compatibility for URLs using the complete git hash (the 40 characters). For URLs using a shorter hash, the URLs will remain broken. This configuration key enables or disables this backward compatibility -which is useful for pagure instances running since before 1.3 but is not +which is useful for Pagure instances running since before 1.3 but is not for newer instances. Defaults to: ``False``. @@ -1410,7 +1410,7 @@ Defaults to: ``False``. DISABLE_REMOTE_PR ~~~~~~~~~~~~~~~~~ -In some pagure deployments remote pull requests need to be disabled +In some Pagure deployments remote pull requests need to be disabled due to legal / policy reasons. Defaults to: ``False``. @@ -1434,7 +1434,7 @@ Defaults to: ``None``. INSTANCE_NAME ~~~~~~~~~~~~~ -This allows giving a name to this running instance of pagure. The name is +This allows giving a name to this running instance of Pagure. The name is then used in the welcome screen shown upon first login. Defaults to: ``Pagure`` @@ -1467,7 +1467,7 @@ DOC_APP_URL This configuration key allows you to specify where the documentation server is running (preferably in a different domain name entirely). If not set, the documentation page will show an error message saying that -this pagure instance does not have a documentation server. +this Pagure instance does not have a documentation server. Defaults to: ``None`` @@ -1490,13 +1490,13 @@ EXCLUDE_GROUP_INDEX This configuration key can be used to hide project an user has access to via one of the groups listed in this key. -The use-case is the following: the Fedora project is deploying pagure has a +The use-case is the following: the Fedora project is deploying Pagure has a front-end for the git repos of the packages in the distribution, that means -about 17,000 git repositories in pagure. The project has a group of people +about 17,000 git repositories in Pagure. The project has a group of people that have access to all of these repositories, so when viewing the user's page of one member of that group, instead of seeing all the project that -this user works on, you can see all the projects hosted in that pagure -instance. Using this configuration key, pagure will hide all the projects +this user works on, you can see all the projects hosted in that Pagure +instance. Using this configuration key, Pagure will hide all the projects that this user has access to via the specified groups and thus return only the groups of forks of that users. @@ -1567,8 +1567,8 @@ EXTERNAL_COMMITTER ~~~~~~~~~~~~~~~~~~ The external committer feature is a way to allow members of groups defined -outside pagure (and provided to pagure upon login by the authentication -system) to be consider committers on pagure. +outside Pagure (and provided to Pagure upon login by the authentication +system) to be consider committers on Pagure. This feature can give access to all the projects on the instance, all but some or just some. @@ -1645,7 +1645,7 @@ GITOLITE_PRE_CONFIG This configuration key allows you to include some content at the *top* of the gitolite configuration file (such as some specific group definition), thus allowing to customize the gitolite configuration file with elements -and information that are outside of pagure's control. +and information that are outside of Pagure's control. This can be used in combination with ``GITOLITE_POST_CONFIG`` to further customize gitolite's configuration file. It can also be used with @@ -1661,7 +1661,7 @@ GITOLITE_POST_CONFIG This configuration key allows you to include some content at the *end* of the gitolite configuration file (such as some project definition or access), thus allowing to customize the gitolite configuration file with elements -and information that are outside of pagure's control. +and information that are outside of Pagure's control. This can be used in combination with ``GITOLITE_PRE_CONFIG`` to further customize gitolite's configuration file. It can also be used with @@ -1711,7 +1711,7 @@ Defaults to: ``{}`` CASE_SENSITIVE ~~~~~~~~~~~~~~ -This configuration key can be used 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`` @@ -1729,7 +1729,7 @@ Defaults to: ``^[a-zA-z0-9_][a-zA-Z0-9-_]*$`` APPLICATION_ROOT ~~~~~~~~~~~~~~~~ -This configuration key is used in the path of the cookie used by pagure. +This configuration key is used in the path of the cookie used by Pagure. Defaults to: ``'/'`` @@ -1768,8 +1768,8 @@ ENABLE_GROUP_MNGT ~~~~~~~~~~~~~~~~~ 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 +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. Defaults to: ``True`` @@ -1779,8 +1779,8 @@ ENABLE_USER_MNGT ~~~~~~~~~~~~~~~~ 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. +removing them from a project) in this Pagure instance. +If turned off, users are managed outside of Pagure. Defaults to: ``True`` @@ -1789,9 +1789,9 @@ ALLOW_USER_REGISTRATION ~~~~~~~~~~~~~~~~~~~~~~~ This configuration key can be used to turn on or off user registration -(that is, the ability for users to create an account) in this pagure instance. +(that is, the ability for users to create an account) in this Pagure instance. If turned off, user accounts cannot be created through the UI or API. -Currently, this key only applies to pagure instances configured with the ``local`` +Currently, this key only applies to Pagure instances configured with the ``local`` authentication backend and has no effect with the other authentication backends. Defaults to: ``True`` @@ -1801,7 +1801,7 @@ SESSION_COOKIE_NAME ~~~~~~~~~~~~~~~~~~~ This configuration key can be used to specify the name of the session cookie used -by pagure. +by Pagure. Defaults to: ``'pagure'`` @@ -1818,9 +1818,9 @@ Defaults to: ``['repos', 'myrepos', 'myforks']`` EMAIL_ON_WATCHCOMMITS ~~~~~~~~~~~~~~~~~~~~~ -By default pagure sends an email to every one watch commits on a project when a +By default Pagure sends an email to every one watch commits on a project when a commit is made. -However some pagure instances may be using a different notification mechanism on +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 can be used to turn on or off email being sent to people watching commits on a project upon commits. @@ -1863,7 +1863,7 @@ Defaults to: ``/usr/share/gitolite3/gitolite-shell`` MIRROR_SSHKEYS_FOLDER ~~~~~~~~~~~~~~~~~~~~~ -This configuration key specificies where pagure should store the ssh keys +This configuration key specificies where Pagure should store the ssh keys generated for the mirroring feature. This folder should be properly backed up and kept secure. @@ -1873,7 +1873,7 @@ Defaults to: ``/var/lib/pagure/sshkeys/`` LOG_ALL_COMMITS ~~~~~~~~~~~~~~~ -This configuration key will make pagure log all commits pushed to all +This configuration key will make Pagure log all commits pushed to all branches of all repositories instead of logging only the once that are pushed to the default branch. @@ -1883,7 +1883,7 @@ Defaults to: ``False`` DISABLE_MIRROR_IN ~~~~~~~~~~~~~~~~~ -This configuration key allows a pagure instance to not support mirroring in +This configuration key allows a Pagure instance to not support mirroring in projects (from third party git server). Defaults to: ``False`` @@ -1950,12 +1950,12 @@ RepoSpanner Options ------------------- Pagure can be integrated with `repoSpanner `_ -allowing to deploy pagure in a load-balanced environment since the git +allowing to deploy Pagure in a load-balanced environment since the git repositories are then synced across multiple servers simultaneously. Support for this integration has been included in Pagure version 5.0 and higher. -Here below are the different options one can/should use to integrate pagure +Here below are the different options one can/should use to integrate Pagure with repoSpanner. REPOBRIDGE_BINARY @@ -1970,7 +1970,7 @@ Defaults to: ``/usr/libexec/repobridge``. REPOSPANNER_NEW_REPO ~~~~~~~~~~~~~~~~~~~~ -This configuration key instructs pagure to create new git repositories on +This configuration key instructs Pagure to create new git repositories on repoSpanner or not. Its value should be the region in which the new git repositories should be created on. @@ -1980,7 +1980,7 @@ Defaults to: ``None``. REPOSPANNER_NEW_REPO_ADMIN_OVERRIDE ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This configuration key can be used to let pagure admin override the default +This configuration key can be used to let Pagure admin override the default region used when creating new git repositories on repoSpanner. Its value should be a boolean. @@ -1989,7 +1989,7 @@ Defaults to: ``False`` REPOSPANNER_NEW_FORK ~~~~~~~~~~~~~~~~~~~~ -This configuration key instructs pagure on where/how to create new git +This configuration key instructs Pagure on where/how to create new git repositories for the forks with repoSpanner. If ``None``, git repositories for forks are created outside of repoSpanner entirely. @@ -2012,7 +2012,7 @@ REPOSPANNER_REGIONS ~~~~~~~~~~~~~~~~~~~ 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. +is deployed and thus with which this Pagure instance can be integrated. An example entry could look like: @@ -2029,7 +2029,7 @@ An example entry could look like: 'key': '/etc/pki/repospanner/pki/pagure.key'}} } -If this configuration key is not defined, pagure will consider that it is +If this configuration key is not defined, Pagure will consider that it is not set to be integrated with repoSpanner. Defaults to: ``{}`` @@ -2095,7 +2095,7 @@ The command to run if a repository is not on repospanner when aclchecker is in u MQTT Options ------------ -If approprietly configured pagure supports sending messages to an MQTT +If approprietly configured Pagure supports sending messages to an MQTT message queue. Here below are the different configuration options to make it so. @@ -2197,7 +2197,7 @@ MQTT_TOPIC_PREFIX ~~~~~~~~~~~~~~~~~ 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 +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. Defaults to: ``None`` @@ -2207,7 +2207,7 @@ ALWAYS_MQTT_ON_COMMITS ~~~~~~~~~~~~~~~~~~~~~~ This configuration key can be used to enforce `mqtt `_ -notifications on commits made on all projects in a pagure instance. +notifications on commits made on all projects in a Pagure instance. Defaults to: ``False``. @@ -2218,7 +2218,7 @@ NOGITHOOKS This configuration key should not be touched. It is used in the test suite as a way to prevent all the git hooks from running (which includes checking if the user is allowed to push). Using this mechanism we are able to check some -behavior in the test suite that in a deployed pagure instance are happening in +behavior in the test suite that in a deployed Pagure instance are happening in a different process. **Do not change this option in production** @@ -2234,7 +2234,7 @@ FORK_FOLDER ~~~~~~~~~~~ This configuration key used to be use to specify the folder where the forks -are placed. Since the release 2.0 of pagure, it has been deprecated, forks +are placed. Since the release 2.0 of Pagure, it has been deprecated, forks are now automatically placed in a sub-folder of the folder containing the mains git repositories (ie ``GIT_FOLDER``). @@ -2247,7 +2247,7 @@ UPLOAD_FOLDER This configuration key used to be use to specify where the uploaded releases are available. It has been replaced by `UPLOAD_FOLDER_PATH` in the release -2.10 of pagure. +2.10 of Pagure. GITOLITE_VERSION @@ -2258,7 +2258,7 @@ using, it can be either ``2`` or ``3``. Defaults to: ``3``. -This has been replaced by `GITOLITE_BACKEND` in the release 3.0 of pagure. +This has been replaced by `GITOLITE_BACKEND` in the release 3.0 of Pagure. DOCS_FOLDER, REQUESTS_FOLDER, TICKETS_FOLDER @@ -2293,7 +2293,7 @@ are not restricted in browser access. Defaults to: ``'https://apps.fedoraproject.org/global/fedora-bootstrap-1.1.1/fedora-bootstrap.css'`` -This has been deprecated by the new way of theming pagure, see the `theming +This has been deprecated by the new way of theming Pagure, see the `theming documentation `_ @@ -2306,7 +2306,7 @@ are not restricted in browser access. Defaults to: ``'https://apps.fedoraproject.org/global/fedora-bootstrap-1.1.1/fedora-bootstrap.js'`` -This has been deprecated by the new way of theming pagure, see the `theming +This has been deprecated by the new way of theming Pagure, see the `theming documentation `_ @@ -2318,7 +2318,7 @@ pages, from ``... - pagure`` (default) to ``... - ``. Defaults to: ``Pagure`` -This has been deprecated by the new way of theming pagure, see the `theming +This has been deprecated by the new way of theming Pagure, see the `theming documentation `_ diff --git a/doc/contributing.rst b/doc/contributing.rst index 88d1b69..ee00fb9 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -1,7 +1,7 @@ Contributing ============ -If you're submitting patches to pagure, please observe the following: +If you're submitting patches to Pagure, please observe the following: - Check that your python code is `PEP8-compliant `_. There is a `flake8 tool diff --git a/doc/contributors.rst b/doc/contributors.rst index 33de076..9bd1bba 100644 --- a/doc/contributors.rst +++ b/doc/contributors.rst @@ -1,4 +1,4 @@ -Contributors to pagure +Contributors to Pagure ====================== Pagure would be nothing without its contributors. @@ -206,7 +206,7 @@ This list is generated using git shortlog -s -n -e -The old pagure logo has been created by ``Micah Denn ``, +The old Pagure logo has been created by ``Micah Denn ``, the new one, as well as the entire version 2 of the user interface (using bootstrap) is the work of ``Ryan Lerch `` many thanks to them for their work and understanding during the process. diff --git a/doc/custom_gitolite_conf.rst b/doc/custom_gitolite_conf.rst index a275005..90157d4 100644 --- a/doc/custom_gitolite_conf.rst +++ b/doc/custom_gitolite_conf.rst @@ -36,6 +36,6 @@ template:: my_git_auth = my_pagure.my_module:MyGitAuthTestHelper """ -Then you can adjust pagure's configuration file to say:: +Then you can adjust Pagure's configuration file to say:: GITOLITE_BACKEND = 'my_git_auth' diff --git a/doc/development.rst b/doc/development.rst index 59d1d99..7a12790 100644 --- a/doc/development.rst +++ b/doc/development.rst @@ -20,7 +20,7 @@ Contributors: Dependencies ------------ -Install the build dependencies of pagure: +Install the build dependencies of Pagure: :: @@ -28,7 +28,7 @@ Install the build dependencies of pagure: libjpeg-devel gcc libffi-devel redhat-rpm-config -The python dependencies of pagure are listed in the file ``requirements.txt`` +The python dependencies of Pagure are listed in the file ``requirements.txt`` at the top level of the sources. :: @@ -45,16 +45,16 @@ at the top level of the sources. but the pygit2 `documentation has a solution for this `_. -How to run pagure +How to run Pagure ----------------- There are several options when it comes to a development environment. Vagrant will provide you with a virtual machine which you can develop on, you can use -a container to run pagure or you can install it directly on your host machine. +a container to run Pagure or you can install it directly on your host machine. The README has detailed instructions for the different options. -Run pagure for development +Run Pagure for development -------------------------- Adjust the configuration file (secret key, database URL, admin group...) See :doc:`configuration` for more detailed information about the @@ -130,17 +130,17 @@ so you can see your change immediately. Create a pull-request for testing ---------------------------------- -When working on pagure, it is pretty often that one wanted to work on a +When working on Pagure, it is pretty often that one wanted to work on a feature or a bug related to pull-requests needs to create one. Making a pull-request for development purposes isn't hard, if you remember that since you're running a local instance, the git repos created in your -pagure instance are also local. +Pagure instance are also local. So here are in a few steps that one could perform to create a pull-request in a -local pagure instance. +local Pagure instance. -* Create a project on your pagure instance, let's say it will be called ``test`` +* Create a project on your Pagure instance, let's say it will be called ``test`` * Create a folder ``clones`` somewhere in your system (you probably do not want it in the ``repos`` folder created above, next to it is fine though):: @@ -179,7 +179,7 @@ local pagure instance. git push -u origin new_branch -Then go back to your pagure instance running in your web-browser, check the +Then go back to your Pagure instance running in your web-browser, check the ``test`` project. You should see two branches: ``master`` and ``new_branch``. From there you should be able to open a new pull-request, either from the front page or via the ``File Pull Request`` button in the ``Pull Requests`` @@ -215,7 +215,7 @@ yourself (which is simple: ``black /path/to/pagure``). Send patch ---------- -The easiest way to work on pagure is to make your own branch in git, make +The easiest way to work on Pagure is to make your own branch in git, make your changes to this branch, commit whenever you want, rebase on master, whenever you need and when you are done, send the patch either by email, via the trac or a pull-request (using git or github). @@ -238,7 +238,7 @@ The workflow would therefore be something like: git format-patch -2 This will create two patch files that you can send by email to submit in a ticket -on pagure, by email or after forking the project on pagure by submitting a +on Pagure, by email or after forking the project on Pagure by submitting a pull-request (in which case the last step above ``git format-patch -2`` is not needed. @@ -251,8 +251,8 @@ needed. uses the title on the Subject line and the rest of the commit in the body. Pagure uses lines that contain only 'Fixes #number' as references - to issues. If for example a commit message of a pagure patch has - a line 'Fixes #3547' and a pullrequest (PR) gets created in pagure, + to issues. If for example a commit message of a Pagure patch has + a line 'Fixes #3547' and a pullrequest (PR) gets created in Pagure, this PR will be linked to from ``https://pagure.io/pagure/issue/3547`` @@ -273,7 +273,7 @@ as tests checking they work the way they are intended to. So here are a few steps that one could perform to run unit-tests in a -local pagure instance. +local Pagure instance. * Install the dependencies:: @@ -312,5 +312,5 @@ Use the following command to run the tests :: This command will build a fedora based container and execute the test suite. You can also limit the tests to unit-test files or single tests similar to the options described above. You need set the environment variables REPO and BRANCH -if the tests are not yet available in the upstream pagure master branch. +if the tests are not yet available in the upstream Pagure master branch. diff --git a/doc/index.rst b/doc/index.rst index 3b313a2..82769ac 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -7,10 +7,10 @@ Features: * ``Open-sources``: Web-interface for the git repositories * ``Flexibility``: Ability to create any project you want -* ``One place``: Keep your documentation and tickets in pagure +* ``One place``: Keep your documentation and tickets in Pagure * ``Collaboration``: Fork a project and make a pull-request * ``Integration``: Create pull-request from a fork hosted somewhere else than in - pagure + Pagure * ``Open data``: Sources, doc, ticket and pull-requests meta-data are available in the web interface but also in git repos which can thus be cloned and changed locally. @@ -53,8 +53,8 @@ Contents: changelog This documentation is generated from the ``doc`` folder in the -`pagure's sources `_. Feel free -to report issues about the documentation on the `pagure issue tracker +`Pagure's sources `_. Feel free +to report issues about the documentation on the `Pagure issue tracker `_ or even better, contribute to it! diff --git a/doc/install.rst b/doc/install.rst index afa1841..3240fe8 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -1,14 +1,14 @@ -Installing pagure +Installing Pagure ================= -There are two ways to install pagure: +There are two ways to install Pagure: * via the RPM package (recommended if you are using a RPM-based GNU/Linux distribution) * via the setup.py -Installing pagure via RPM +Installing Pagure via RPM ------------------------- Here as well there are two ways of obtaining the RPM: @@ -40,13 +40,13 @@ The ``pagure-ev`` package contains the eventsource server. The ``pagure-webhook`` package contains the web-hook server. -.. note:: The last three packages are optional, pagure would work fine without +.. note:: The last three packages are optional, Pagure would work fine without them but the live-update, the webhook and the comment by email services will not work. * From the sources -If you wish to run a newer version of pagure than what is in the repositories +If you wish to run a newer version of Pagure than what is in the repositories you can easily rebuild it as RPM. Simply follow these steps: @@ -66,7 +66,7 @@ Simply follow these steps: rpmbuild -ta dist/pagure*.tar.gz -This will build pagure from the version present in your clone. +This will build Pagure from the version present in your clone. Once, the RPM is installed the services ``pagure_milter`` and ``pagure_ev`` @@ -75,14 +75,14 @@ need to be configured. -Installing pagure via setup.py +Installing Pagure via setup.py ------------------------------ Pagure includes in its sources a ``setup.py`` automating the installation -of the web applications of pagure (ie: the core + the doc server). +of the web applications of Pagure (ie: the core + the doc server). -To install pagure via this mechanism simply follow these steps: +To install Pagure via this mechanism simply follow these steps: # Clone the sources:: git clone https://pagure.io/pagure.git @@ -117,10 +117,10 @@ To install pagure via this mechanism simply follow these steps: -Set-up pagure +Set-up Pagure ------------- -Once pagure's files are installed, you still need to set up some things. +Once Pagure's files are installed, you still need to set up some things. * Create the folder release @@ -196,19 +196,19 @@ Where ``/srv/git`` is the home of your gitolite user (which will thus need to be adjusted for your configuration). -* Set up the configuration file of pagure +* Set up the configuration file of Pagure This is an important step which concerns the file ``/etc/pagure/pagure.cfg``. -If you have installed pagure by RPM, this file is already there, otherwise +If you have installed Pagure by RPM, this file is already there, otherwise you can find an example one in the sources at: ``files/pagure.cfg.sample`` that you will have to copy to the right location. Confer the ``Configuration`` section of this documentation for a full -explanation of all the options of pagure. +explanation of all the options of Pagure. * Create the database -You first need to create the database itself. For this, since pagure can +You first need to create the database itself. For this, since Pagure can work with: `PostgreSQL `_, `MySQL `_ or `MariaDB `_, we would like to invite you to consult the documentation of your database system @@ -228,11 +228,11 @@ In the ``alembic.ini`` file, one of the configuration key is most important: ``script_location`` which is the path to the ``versions`` folder containing all the alembic migration files. The ``sqlalchemy.url`` configuration key if missing will be replaced by the url filled in the configuration file of -pagure. +Pagure. To create the database tables, you need to run the script ``/usr/share/pagure/pagure_createdb.py`` and specify the configuration -to use for pagure and for alembic. +to use for Pagure and for alembic. For example: :: @@ -258,7 +258,7 @@ In the ``alembic.ini`` file, one of the configuration key is most important: ``script_location`` which is the path to the ``versions`` folder containing all the alembic migration files. The ``sqlalchemy.url`` configuration key if missing will be replaced by the url filled in the configuration file of -pagure. +Pagure. .. warning:: Calling ``pagure_createdb.py`` is asked regularly in the UPGRADING.rst documentation, especially to handle database schema diff --git a/doc/install_crons.rst b/doc/install_crons.rst index 288d842..db4d9bd 100644 --- a/doc/install_crons.rst +++ b/doc/install_crons.rst @@ -1,7 +1,7 @@ Cron Jobs ========= -Some actions in pagure are meant to the run via a cron job. +Some actions in Pagure are meant to the run via a cron job. API key expiration reminder diff --git a/doc/install_pagure_ci.rst b/doc/install_pagure_ci.rst index 3b9ae78..e99fd30 100644 --- a/doc/install_pagure_ci.rst +++ b/doc/install_pagure_ci.rst @@ -8,8 +8,8 @@ configured to integrate results coming from CI services, such as `Jenkins against the project. -.. note: Currently, pagure only supports `Jenkins` but we welcome help to - integrate pagure with other services such as `travis-ci +.. note: Currently, Pagure only supports `Jenkins` but we welcome help to + integrate Pagure with other services such as `travis-ci `_. @@ -43,7 +43,7 @@ CI service when there is a new pull-request or a change to an existing one. The second file is the systemd service file. -* Configure your pagure instance to support CI, add the following to your +* Configure your Pagure instance to support CI, add the following to your configuration file :: diff --git a/doc/install_pagure_ev.rst b/doc/install_pagure_ev.rst index 614f312..f942fa5 100644 --- a/doc/install_pagure_ev.rst +++ b/doc/install_pagure_ev.rst @@ -1,4 +1,4 @@ -Installing pagure's EventSource server +Installing Pagure's EventSource server ====================================== Eventsource or Server Sent Events are messages sent from a server to a web diff --git a/doc/install_pagure_loadjson.rst b/doc/install_pagure_loadjson.rst index 4b13f06..ca6e6ca 100644 --- a/doc/install_pagure_loadjson.rst +++ b/doc/install_pagure_loadjson.rst @@ -31,7 +31,7 @@ Configure your system +--------------------------------------------------+----------------------------------------------------+ The first file is the pagure-loadjson service itself, triggered by the git -hook (shipped with pagure itself) and loading the JSON files into the database. +hook (shipped with Pagure itself) and loading the JSON files into the database. The second file is the systemd service file. diff --git a/doc/install_pagure_logcom.rst b/doc/install_pagure_logcom.rst index f92e0b3..21ed0dc 100644 --- a/doc/install_pagure_logcom.rst +++ b/doc/install_pagure_logcom.rst @@ -31,7 +31,7 @@ Configure your system +-----------------------------------------------+-------------------------------------------------------+ The first file is the pagure-logcom service itself, triggered by the git -hook (shipped with pagure itself) and logging the commits into the database. +hook (shipped with Pagure itself) and logging the commits into the database. The second file is the systemd service file. diff --git a/doc/install_pagure_milter.rst b/doc/install_pagure_milter.rst index f1025c9..8458e61 100644 --- a/doc/install_pagure_milter.rst +++ b/doc/install_pagure_milter.rst @@ -1,4 +1,4 @@ -Installing pagure's milter +Installing Pagure's milter ========================== A milter is a script that is ran by a Mail Transfer Agent (`MTA diff --git a/doc/install_pagure_webhooks.rst b/doc/install_pagure_webhooks.rst index 9aff374..2dc4274 100644 --- a/doc/install_pagure_webhooks.rst +++ b/doc/install_pagure_webhooks.rst @@ -1,4 +1,4 @@ -Installing pagure's web-hooks notification system +Installing Pagure's web-hooks notification system ================================================= Web-hooks are a notification system upon which a system makes a http POST diff --git a/doc/overview.rst b/doc/overview.rst index e732993..1794145 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -12,7 +12,7 @@ These components are: Before going into the overall picture, one should realize that most of the components listed above are optional. -Here is a diagram representing pagure without all the optional components: +Here is a diagram representing Pagure without all the optional components: .. image:: _static/overview_simple.png :target: _images/overview_simple.png @@ -37,7 +37,7 @@ Pagure workers Interacting with git repos can be a long process, it varies depending on the size of the repository itself but also based on hardware performances or simply the load on the system. -To make pagure capable of handling more load, since pagure 3.0 the interactions +To make Pagure capable of handling more load, since Pagure 3.0 the interactions with the git repositories from the web UI is performed by dedicated workers, allowing async processing of the different tasks. @@ -50,7 +50,7 @@ The communication between the core application and its worker is based on Gitolite -------- -Currently pagure uses `gitolite `_ +Currently Pagure uses `gitolite `_ to grant or deny `ssh `_ access to the git repositories, in other words to grant or deny read and/or write access to the git repositories. @@ -67,7 +67,7 @@ for security concern, displaying information directly provided by the user without a clear/safe way of filtering for unsafe script or hacks is a security hole. For this reason we also strongly encourage anyone wanting to deploy their -own instance of pagure with the doc server, to run this application on a +own instance of Pagure with the doc server, to run this application on a completely different domain name (not just a sub-domain) in order to reduce the cross-site forgery risks. @@ -81,7 +81,7 @@ Pagure milter The milter is a script, receiving an email as input and performing an action with it. -In the case of pagure, the milter is used to allow replying on a comment +In the case of Pagure, the milter is used to allow replying on a comment of a ticket or a pull-request by directly replying to the notification sent. No need to go to the page anymore to reply to a comment someone made. @@ -94,12 +94,12 @@ Pagure EventSource Server Eventsource or Server Sent Events are messages sent from a server to a browser. -For pagure this technology is used to allow live-refreshing of a page when +For Pagure this technology is used to allow live-refreshing of a page when someone is viewing it. For example, while you are reading a ticket if someone comments on it, the comment will automatically show up on the page without the need for you to reload the entire page. -The flow is: the main pagure server does an action, sends a message over +The flow is: the main Pagure server does an action, sends a message over redis, the eventsource server picks it up and send it to the browsers waiting for it, then javascript code is executed to refresh the page based on the information received. @@ -110,12 +110,12 @@ Pagure web-hook Server Sends notifications to third party services using POST http requests. -This is the second notifications system in pagure with `fedmsg `_. +This is the second notifications system in Pagure with `fedmsg `_. These notifications are running on their own service to prevent blocking the main web application in case the third part service is timing-out or just being slow. -The flow is: the main pagure server does an action, sends a message over +The flow is: the main Pagure server does an action, sends a message over redis, the web-hook server picks it up, build the query and performs the POST request to the specified URLs. diff --git a/doc/usage/first_steps.rst b/doc/usage/first_steps.rst index 8a4f3d4..fe959f6 100644 --- a/doc/usage/first_steps.rst +++ b/doc/usage/first_steps.rst @@ -1,17 +1,17 @@ .. _first-steps: -First Steps on pagure +First Steps on Pagure ===================== -When coming to pagure for the first time there are a few things one should +When coming to Pagure for the first time there are a few things one should do or check to ensure all works as desired. -Login to pagure or create your account +Login to Pagure or create your account -------------------------------------- Pagure has its own user account system. -For instances of pagure such as the one at `pagure.io `_ +For instances of Pagure such as the one at `pagure.io `_ where the authentication is delegated to a third party (in the case of pagure.io, the Fedora Account System) via OpenID, the local user account is created upon login. @@ -19,7 +19,7 @@ is created upon login. This means, you cannot be added to a group or a project before you login for the first time as the system will simply not know you. -If you run your own pagure instance which uses the local authentication +If you run your own Pagure instance which uses the local authentication system, then you will find on the login page an option to create a new account. @@ -50,11 +50,11 @@ folder). These two files will be named (for example) ``id_rsa`` and ``id_rsa.pub``. The first one is the private key that must never be shared. The second is -the public key that can be uploaded on pagure to give you ssh access. +the public key that can be uploaded on Pagure to give you ssh access. -To upload your public key onto pagure: +To upload your public key onto Pagure: -1. Login into pagure and click on the user icon on +1. Login into Pagure and click on the user icon on the top right corner, there, select ``My settings``. .. image:: _static/pagure_my_settings.png @@ -76,9 +76,9 @@ the top right corner, there, select ``My settings``. Configure the default email address ----------------------------------- -If the pagure instance you use is using local user authentication, you can +If the Pagure instance you use is using local user authentication, you can choose whichever email address you prefer to use during account creation. -But in the case (like pagure.io) where the pagure instance relies +But in the case (like pagure.io) where the Pagure instance relies on an external authentication service, the email address provided by this service may be different from the one you prefer. diff --git a/doc/usage/flags.rst b/doc/usage/flags.rst index 65f28ad..b308fbf 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``. diff --git a/doc/usage/http_push.rst b/doc/usage/http_push.rst index fc00be5..25b691c 100644 --- a/doc/usage/http_push.rst +++ b/doc/usage/http_push.rst @@ -1,7 +1,7 @@ HTTP PUSH ========= -When using git push over http against a pagure instance, there are two +When using git push over http against a Pagure instance, there are two situations to distinguish. Git push over http with API token @@ -31,11 +31,11 @@ For example: Git push over http with Username & Password ------------------------------------------- -This is only supported on pagure instance that are using the ``local`` -authentication system (ie: where pagure manages the registration of the +This is only supported on Pagure instance that are using the ``local`` +authentication system (ie: where Pagure manages the registration of the user accounts, email confirmation, etc). -For these pagure instances and for these only, when being prompted by git +For these Pagure instances and for these only, when being prompted by git for an username and password the user can choose to enter either their username and actual password or their username and an API token. diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 693fef4..a72afa2 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -1,16 +1,16 @@ Usage ===== -Using pagure should come fairly easily, especially to people already used +Using Pagure should come fairly easily, especially to people already used to forges such as GitHub or GitLab. There are however some tips and tricks which can be useful to know and that this section of the doc covers. One of the major difference with GitHub and GitLab is that for each project -on pagure, four git repositories are made available: +on Pagure, four git repositories are made available: * A git repository containing the source code, displayed in the main section - of the pagure project. + 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 @@ -26,7 +26,7 @@ pull-requests (the `pag-off `_ project for example relies on a local copy of the issue git repository). They are designed to allow you to have full access to all the data about your project. One of the original idea was also to allow syncing a project between multiple -pagure instances by syncing these git repositories between the instances. +Pagure instances by syncing these git repositories between the instances. You can find the URLs to access or clone these git repositories on the overview page of the project. On the top right of the page, in the drop-down @@ -68,4 +68,4 @@ Pagure API ---------- The API documentation can be found at `https://pagure.io/api/0/ `_ -or in ``/api/0/`` of you local pagure instance. +or in ``/api/0/`` of you local Pagure instance. diff --git a/doc/usage/magic_words.rst b/doc/usage/magic_words.rst index 5b70c49..8f771bd 100644 --- a/doc/usage/magic_words.rst +++ b/doc/usage/magic_words.rst @@ -2,12 +2,12 @@ Magic Words =========== Magic words are words and constructs you can use in your commit message to -make pagure act on tickets or pull-requests. +make Pagure act on tickets or pull-requests. Enabling magic words -------------------- -These magic words are enabled if the ``pagure`` git hook is enable. To do +These magic words are enabled if the ``Pagure`` git hook is enable. To do so, go to your project's ``settings`` page, open the ``Hooks`` tab and activate there the ``Pagure`` hook. diff --git a/doc/usage/markdown.rst b/doc/usage/markdown.rst index 2cdbd4a..7de354a 100644 --- a/doc/usage/markdown.rst +++ b/doc/usage/markdown.rst @@ -33,7 +33,7 @@ While comments use: .. warning:: Pagure does not support linking to remote images, if you want - to link to an image on a ticket, you will have to upload it to pagure. + to link to an image on a ticket, you will have to upload it to Pagure. Styling ------- diff --git a/doc/usage/pagure_ci.rst b/doc/usage/pagure_ci.rst index a2a8047..0278186 100644 --- a/doc/usage/pagure_ci.rst +++ b/doc/usage/pagure_ci.rst @@ -3,10 +3,10 @@ Pagure CI Pagure CI is a service integrating the results of Continuous Integration (CI) services, such as jenkins or travis-ci, into pull-requests opened against -your project on pagure. +your project on Pagure. -.. note:: By default pagure-ci is off, an admin of your pagure instance will +.. note:: By default pagure-ci is off, an admin of your Pagure instance will need to configure it to support one or more CI services. Check the configuration section on how to do that. @@ -29,5 +29,5 @@ a comment saying: ``pretty please pagure-ci rebuild``. .. note:: To always have this handy, you can save it in the ``Quick Replies``! -.. note:: This trigger can also be configured per pagure instance via the +.. note:: This trigger can also be configured per Pagure instance via the configuration file. diff --git a/doc/usage/pagure_ci_jenkins.rst b/doc/usage/pagure_ci_jenkins.rst index bacfc23..77217b8 100644 --- a/doc/usage/pagure_ci_jenkins.rst +++ b/doc/usage/pagure_ci_jenkins.rst @@ -2,7 +2,7 @@ Jenkins with Pagure-ci ====================== Jenkins is a Continuous Integration service that can be configured to be -integrated with pagure. +integrated with Pagure. This document describe the steps needed to make it work. @@ -11,17 +11,17 @@ How does it work? The principal is: -* pagure will trigger a build on jenkins when a pull-request is created, - updated or when someone explicitly asks pagure to do so or when a new commit +* Pagure will trigger a build on jenkins when a pull-request is created, + 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: +* Pagure will send a few information to jenkins when triggering a build: ``REPO``, ``BRANCH``, ``BRANCH_TO``, ``cause``. -* jenkins will do its work and, using webhook, report to pagure that it has +* jenkins will do its work and, using webhook, report to Pagure that it has finished its task -* pagure will query jenkins to know the outcome of the task and flag the PR +* Pagure will query jenkins to know the outcome of the task and flag the PR accordingly ``REPO`` corresponds to the url of the repository the pull-request originates @@ -87,7 +87,7 @@ Configure your project on Jenkins FORMAT: JSON PROTOCOL: HTTP EVENT: All Events - URL: + URL: TIMEOUT: 3000 LOG: 1 @@ -95,10 +95,10 @@ Configure your project on Jenkins * Add two `String Parameters` named REPO and BRANCH -* Source Code Management select Git and give the URL of the pagure project +* Source Code Management select Git and give the URL of the Pagure project * Under Build Trigger click on Trigger build remotely and specify the token - given by pagure. + given by Pagure. * Under Build -> Add build step -> Execute Shell diff --git a/doc/usage/project_acls.rst b/doc/usage/project_acls.rst index 283a842..4797f68 100644 --- a/doc/usage/project_acls.rst +++ b/doc/usage/project_acls.rst @@ -1,7 +1,7 @@ Project Level Access Control ============================ -Till release 2.12, pagure had a very simple user model. If we added a new +Till release 2.12, Pagure had a very simple user model. If we added a new user or a new group to a project, the user/group would be an admin of the project. The user/group could do everything from changing the status of an issue to adding or removing any user on the project. With project ACL feature, we allow a more fine @@ -50,7 +50,7 @@ Add/Update Access Points to be noted ------------------ -* The creator of a project in pagure holds a more unique position than a normal user +* 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 can not be changed. But, an admin's access can be updated by a fellow admin or the creator himself. diff --git a/doc/usage/project_settings.rst b/doc/usage/project_settings.rst index 8773c98..954c94d 100644 --- a/doc/usage/project_settings.rst +++ b/doc/usage/project_settings.rst @@ -14,16 +14,16 @@ This page presents the different settings and there effect. 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: +When merging a pull-request in Pagure there are three states: * fast-forward: when the commits in the pull-request can be fast-forwarded - pagure signals it and just fast-forward the commit, keeping the history linear. + Pagure signals it and just fast-forward the commit, keeping the history linear. * merge: when the commits in the pull-request cannot be merged without a merge - commit, pagure signals it and performs this merge commit. + commit, Pagure signals it and performs this merge commit. * conflicts: when the commits in the pull-request cannot be merged at all - automatically due to one or more conflicts. Then pagure signals it and prevent + automatically due to one or more conflicts. Then Pagure signals it and prevent merging. If the `Always merge` option is on, then the `fast-forward` option @@ -59,7 +59,7 @@ and this setting allows turning it on or off. 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` +If this line is missing, Pagure will display a message near the `Merge` button, allowing project admin to request the PR to be updated. .. note:: This setting does not prevent commits without this 'signed-off-by' @@ -71,7 +71,7 @@ button, allowing project admin to request the PR to be updated. 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. +disable reporting issue on Pagure by un-checking this option. `Minimum score to merge pull-request` @@ -149,13 +149,13 @@ prevent anyone from opening a pull-request against this project. Pagure offers the option of sending notification about event happening on a project via [web-hooks|https://en.wikipedia.org/wiki/Webhook]. This option -is off by default and can be turned on for a pagure instance in its +is off by default and can be turned on for a Pagure instance in its configuration file. The URL of the web-hooks can be entered in this field. .. note:: See the ``notifications`` documentation to learn more about - web-hooks in pagure and how to use them. + web-hooks in Pagure and how to use them. `Tags` ------ diff --git a/doc/usage/pull_requests.rst b/doc/usage/pull_requests.rst index 770c4a2..1409797 100644 --- a/doc/usage/pull_requests.rst +++ b/doc/usage/pull_requests.rst @@ -22,7 +22,7 @@ ready to contribute to the project. Pagure to Pagure pull request ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -You can create a pull request from a pagure project, using one of the following options +You can create a pull request from a Pagure project, using one of the following options From the project overview ************************* @@ -144,7 +144,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 f095f53..639d6db 100644 --- a/doc/usage/read_only.rst +++ b/doc/usage/read_only.rst @@ -15,7 +15,7 @@ given that he had at least commit access, until the read only mode is over. In Pagure, we use gitolite for Access Control Lists when using SSH. Modifying gitolite may be a time taking task (depending on number of projects -hosted on the pagure instance) that's why Pagure does it outside of HTTP +hosted on the Pagure instance) that's why Pagure does it outside of HTTP Request-Response Cycle. Whenever you fork a project or add/remove a new user/group to project, diff --git a/doc/usage/theming.rst b/doc/usage/theming.rst index 21b2dc0..bb1ba6f 100644 --- a/doc/usage/theming.rst +++ b/doc/usage/theming.rst @@ -3,7 +3,7 @@ Theming Guide Pagure is built on Flask, and uses Jinja2 for templates. Pagure also includes the ability to apply different themes that control the look -and feel of your pagure instance, or add or remove elements from the +and feel of your Pagure instance, or add or remove elements from the interface. Setting a theme @@ -26,9 +26,9 @@ is placed in the templates directory templates/ ~~~~~~~~~~ -The `templates` directory is where pagure will look for the `theme.html` +The `templates` directory is where Pagure will look for the `theme.html` template. Additionally, if you wish to override any template in Pagure, -place it in the theme templates/ directory, and pagure will use that +place it in the theme templates/ directory, and Pagure will use that template rather than the standard one. .. warning:: Take care when overriding templates, as any changes to Pagure @@ -52,7 +52,7 @@ templates/theme.html The theme.html file defines a subset of items in the Pagure interface that are commonly changed when creating a new theme. Theming is a new feature in Pagure, so this set is currently small, but please file issues or PRs against -pagure with ideas of new items to include. +Pagure with ideas of new items to include. The current items configurable in theme.html are: diff --git a/doc/usage/tips_tricks.rst b/doc/usage/tips_tricks.rst index d0e4195..bd78882 100644 --- a/doc/usage/tips_tricks.rst +++ b/doc/usage/tips_tricks.rst @@ -1,7 +1,7 @@ Tips and tricks =============== -This page contains some tips and tricks on how to use pagure. These do not +This page contains some tips and tricks on how to use Pagure. These do not fit in their own page but are worth mentioning. Place image onto your overview page @@ -21,7 +21,7 @@ Text in the square brackets will be used as an alt description. Pre-fill issue using the URL ---------------------------- -When creating issues for a project pagure supports pre-filling the title +When creating issues for a project Pagure supports pre-filling the title and description input text using URL parameters. Example: @@ -35,7 +35,7 @@ with Title set to and Description set to . Pre-fill issue template using the URL ------------------------------------- -When creating issues for a project pagure supports pre-filling the title +When creating issues for a project Pagure supports pre-filling the title and description input text using URL parameters. Example: @@ -50,8 +50,8 @@ TemplateName should be the name of the template file on disk (in the Filter for issues *not* having a certain tag -------------------------------------------- -Very much in the same way pagure allows you to filter for issues having a -certain tag, pagure allows one to filter for issues *not* having a certain tag. +Very much in the same way Pagure allows you to filter for issues having a +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: diff --git a/doc/usage/trouble/inaccessible_pr.rst b/doc/usage/trouble/inaccessible_pr.rst index 1ada50e..7582473 100644 --- a/doc/usage/trouble/inaccessible_pr.rst +++ b/doc/usage/trouble/inaccessible_pr.rst @@ -41,7 +41,7 @@ This can be done using git simply by doing: git checkout -b git push origin -It will create the branch named ```` in pagure, allowing the +It will create the branch named ```` in Pagure, allowing the diff to be computed for that pull-request and thus allowing it to be displayed. It is then up to you to see if this pull-request is still relevant and should be merged or closed. diff --git a/doc/usage/troubleshooting.rst b/doc/usage/troubleshooting.rst index 2b662fc..013fdd7 100644 --- a/doc/usage/troubleshooting.rst +++ b/doc/usage/troubleshooting.rst @@ -1,7 +1,7 @@ Troubleshooting =============== -This page lists some of the potential issues one may have in pagure as well +This page lists some of the potential issues one may have in Pagure as well as their solution(s). Contents: diff --git a/doc/usage/upgrade_db.rst b/doc/usage/upgrade_db.rst index d16166f..bde270d 100644 --- a/doc/usage/upgrade_db.rst +++ b/doc/usage/upgrade_db.rst @@ -11,7 +11,7 @@ To upgrade the database to the latest version simply run: alembic upgrade head -.. note:: if pagure's configuration file isn't in ``/etc/pagure/pagure.cfg`` +.. note:: if Pagure's configuration file isn't in ``/etc/pagure/pagure.cfg`` you will have to specify it to alembic using the command: :: PAGURE_CONFIG=/path/to/pagure.cfg alembic upgrade head diff --git a/doc/usage/using_doc.rst b/doc/usage/using_doc.rst index 9fea8e6..5fcaf02 100644 --- a/doc/usage/using_doc.rst +++ b/doc/usage/using_doc.rst @@ -61,7 +61,7 @@ Updating documentation hosted in a dedicated repo is like Example ------- -Pagure's documentation is kept in pagure's sources, in the `doc` folder there. +Pagure's documentation is kept in Pagure's sources, in the `doc` folder there. You can see it at: `https://pagure.io/pagure/blob/master/f/doc `_. This doc can be built with `Sphinx `_ to make it HTML and prettier. @@ -71,7 +71,7 @@ The built documentation is available at: `https://docs.pagure.org/pagure/ This is how it is built/updated: -* Clone pagure's sources:: +* Clone Pagure's sources:: git clone https://pagure.io/pagure.git @@ -83,7 +83,7 @@ This is how it is built/updated: make html -* Clone pagure's doc repository:: +* Clone Pagure's doc repository:: git clone ssh://git@pagure.io/docs/pagure.git @@ -129,7 +129,7 @@ used: It can be used by running `update_doc.sh ` from within the folder containing the doc. -So for pagure it would be something like: +So for Pagure it would be something like: :: diff --git a/doc/usage/using_webhooks.rst b/doc/usage/using_webhooks.rst index 51b4282..bf75344 100644 --- a/doc/usage/using_webhooks.rst +++ b/doc/usage/using_webhooks.rst @@ -2,7 +2,7 @@ Using web-hooks =============== Web-hooks are a notification system that could be compared to a callback. -Basically, pagure will make a HTTP POST request to one or more third party +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 notifications @@ -18,15 +18,15 @@ on this project: new issue, new pull-request, new comments, new commits... .. note:: The notifications sent via web-hooks have the same payload as the notifications sent via `fedmsg `_. - Therefore, the list of pagure topics as well as example messages can be - found in the `fedmsg documentation about pagure + Therefore, the list of Pagure topics as well as example messages can be + found in the `fedmsg documentation about Pagure `_ Authenticating the notifications -------------------------------- 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 +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 some specific headers: @@ -39,15 +39,15 @@ Each POST request made contains some specific headers: X-Pagure-Signature-256 X-Pagure-Topic -``X-Pagure`` contains URL of the pagure instance sending this notification. +``X-Pagure`` contains URL of the Pagure instance sending this notification. -``X-Pagure-Project`` contains the name of the project on that pagure instance. +``X-Pagure-Project`` contains the name of the project on that Pagure instance. ``X-Pagure-Signature`` contains the signature of the message allowing to -check that the message comes from pagure. +check that the message comes from Pagure. ``X-Pagure-Signature-256`` contains the SHA-256 signature of the message -allowing to check that the message comes from pagure. +allowing to check that the message comes from Pagure. .. note:: These headers are present to allow you to verify that the webhook was actually sent by the correct Pagure instance. These are not From c10deacfadc176e14f640661a114fb1c3e8b39fc Mon Sep 17 00:00:00 2001 From: four_4 Date: Oct 29 2022 01:44:26 +0000 Subject: [PATCH 2/2] Added data-toggle attribute to missing tooltips (Issue #4965) --- diff --git a/.vs/ProjectSettings.json b/.vs/ProjectSettings.json new file mode 100644 index 0000000..f8b4888 --- /dev/null +++ b/.vs/ProjectSettings.json @@ -0,0 +1,3 @@ +{ + "CurrentProjectSetting": null +} \ No newline at end of file diff --git a/.vs/pagure/v16/.suo b/.vs/pagure/v16/.suo new file mode 100644 index 0000000..ba3e36f Binary files /dev/null and b/.vs/pagure/v16/.suo differ diff --git a/.vs/slnx.sqlite b/.vs/slnx.sqlite new file mode 100644 index 0000000..ac8bcf4 Binary files /dev/null and b/.vs/slnx.sqlite differ diff --git a/pagure/templates/commits.html b/pagure/templates/commits.html index 807159b..8aee5c9 100644 --- a/pagure/templates/commits.html +++ b/pagure/templates/commits.html @@ -115,6 +115,7 @@ {{ diff_commit_full.author | author2avatar(20) | safe }} {{ diff_commit_full.author.name }} • {{ diff_commit_full.commit_time|humanize }}   @@ -172,6 +173,7 @@ author=commit.author.email), cssclass="notblue")|safe}} • {{ commit.commit_time|humanize }}   diff --git a/pagure/templates/file_history.html b/pagure/templates/file_history.html index d2503b0..95b7b61 100644 --- a/pagure/templates/file_history.html +++ b/pagure/templates/file_history.html @@ -128,6 +128,7 @@ author=commit.author.email), cssclass="notblue")|safe}} • {{ commit.commit_time|humanize }}   diff --git a/pagure/templates/issue.html b/pagure/templates/issue.html index ca8f20e..56ff93e 100644 --- a/pagure/templates/issue.html +++ b/pagure/templates/issue.html @@ -97,7 +97,7 @@ Opened {{ issue.date_created |humanize }} - by {{ issue.user.user }}. + by {{ issue.user.user }}. {% endif %} diff --git a/pagure/templates/repo_comparecommits.html b/pagure/templates/repo_comparecommits.html index 7826ea1..5c76efe 100644 --- a/pagure/templates/repo_comparecommits.html +++ b/pagure/templates/repo_comparecommits.html @@ -95,6 +95,7 @@ author=commit.author.email), cssclass="notblue")|safe}} • {{ commit.commit_time|humanize }}   diff --git a/pagure/templates/repo_new_pull_request.html b/pagure/templates/repo_new_pull_request.html index 7687df1..bec836b 100644 --- a/pagure/templates/repo_new_pull_request.html +++ b/pagure/templates/repo_new_pull_request.html @@ -290,6 +290,7 @@ author=commit.author.email), cssclass="notblue")|safe}} • {{ commit.commit_time|humanize }}   diff --git a/pagure/templates/repo_pull_request.html b/pagure/templates/repo_pull_request.html index 9fcd1e5..29a5066 100644 --- a/pagure/templates/repo_pull_request.html +++ b/pagure/templates/repo_pull_request.html @@ -68,7 +68,7 @@ Opened {{ pull_request.date_created |humanize }} - by {{ pull_request.user.user }}. + by {{ pull_request.user.user }}. {% elif pull_request.status == 'Closed' %} Closed {{ pull_request.closed_at |humanize }} @@ -78,7 +78,7 @@ Opened {{ pull_request.date_created |humanize }} - by {{ pull_request.user.user }}. + by {{ pull_request.user.user }}. {% endif %} @@ -342,6 +342,7 @@ author=commit.author.email), cssclass="notblue")|safe}} • {{ commit.commit_time|humanize }}