From 13832f205a08003a05ca36011d76e23382ea68b6 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Jul 27 2018 14:30:25 +0000 Subject: Improve documentation about the different git repos and point to it This commit improves the documentation about the different git repositories associated with a project. In addition, we're fixing the indentation in the repo_master template and adding a link to the documentation about the different git repos. Fixes https://pagure.io/pagure/issue/3451 Signed-off-by: Pierre-Yves Chibon --- diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 506d9b3..807ab02 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -16,17 +16,23 @@ on pagure, four git repositories are made available: * A git repository for the metadata for pull-requests -Issues and pull-requests repositories are not public and only available to -admins and committers of the project, since they can contain private tickets. +Issues and pull-requests repositories contain the meta-data (comments, +notifications, assignee...) from the issues and pull-request. They are are +not public and only available to admins and committers of the project, +since they may contain private information. + +You can use these repositories for offline access to your tickets or +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. You can find the URLs to access or clone these git repositories on the -overview page of the project. On the menu on the right side, there is a menu -`Source GIT URLs`, next to it is a little `more` button, by clicking on it -as project admin or committer you will be given the URLs to the other three git repos. - -Each section correspond to one of the four git repositories created for each -project. - +overview page of the project. On the top right of the page, in the drop-down +menu entitled ``Clone``. Beware that if documentation, the issue tracker or +the pull-requests are disabled on the project, the corresponding URL will +not be shown. Contents: diff --git a/pagure/templates/repo_master.html b/pagure/templates/repo_master.html index 44a4457..03c4719 100644 --- a/pagure/templates/repo_master.html +++ b/pagure/templates/repo_master.html @@ -161,58 +161,68 @@ {% endif %}
- - Clone - -
-
-
Source Code
-
- {% if g.authenticated and g.repo_committer %} - {{ print_ssh_url(repo, g.fas_user.username) }} - {% endif %} -
-
-
GIT
- -
-
-
- {% if config['DOC_APP_URL'] - and repo - and repo.settings.get('project_documentation', True) %} -
Documentation
- {% if g.authenticated and g.repo_committer %} - {{ print_ssh_url(repo, "docs/", g.fas_user.username) }} - {% endif %} -
-
-
GIT
- -
-
- {% endif %} - {% if g.authenticated and g.repo_committer %} - {% if config.get('ENABLE_TICKETS', True) - and repo.settings.get('issue_tracker', True) %} -
Issues
- {{ print_ssh_url(repo, "tickets/", g.fas_user.username) }} - {% endif %} -
Pull Requests
- {{ print_ssh_url(repo, "requests/", g.fas_user.username) }} - {% endif %} -
+ class="btn btn-sm dropdown-toggle btn-outline-primary" + data-toggle="dropdown" id="watch-button"> + + Clone + +
+
+
+
Source Code
+ {% if g.authenticated and g.repo_committer %} + {{ print_ssh_url(repo, g.fas_user.username) }} + {% endif %} + +
+
+
GIT
+
-
-
+ + {% if config['DOC_APP_URL'] + and repo + and repo.settings.get('project_documentation', True) %} +
Documentation
+ {% if g.authenticated and g.repo_committer %} + {{ print_ssh_url(repo, "docs/", g.fas_user.username) }} + {% endif %} +
+
+
GIT
+ +
+
+ {% endif %} + + {% if g.authenticated and g.repo_committer %} + {% if config.get('ENABLE_TICKETS', True) + and repo.settings.get('issue_tracker', True) %} +
Issues
+ {{ print_ssh_url(repo, "tickets/", g.fas_user.username) }} + {% endif %} +
Pull Requests
+ {{ print_ssh_url(repo, "requests/", g.fas_user.username) }} + {% endif %} + +
+

+ + Learn more about these different git repos. + +

+ +
+ +
+ +