From 226c43b7e7cd842c0a6f44ec5c2c40855ff53d0c Mon Sep 17 00:00:00 2001 From: Jeremy Cline Date: Feb 03 2017 18:38:11 +0000 Subject: Move usage.rst to be the index of usage/ It was confusing to have both a usage.rst and a usage directory, so this just moves the usage.rst to be the index of the usage directory. This also moves the usage guide to the top of the TOC after the overview since most people will be looking for the user guide. Signed-off-by: Jeremy Cline --- diff --git a/doc/index.rst b/doc/index.rst index 3daea4c..d5ea43f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -30,6 +30,7 @@ Contents: :maxdepth: 2 overview + usage/index install install_milter install_evs @@ -37,7 +38,6 @@ Contents: install_pagure_ci configuration development - usage contributing contributors diff --git a/doc/usage.rst b/doc/usage.rst deleted file mode 100644 index 023648e..0000000 --- a/doc/usage.rst +++ /dev/null @@ -1,47 +0,0 @@ -Usage -===== - -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 to the admins of the -project: - -* A git repository containing the source code, displayed in the main section - 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 - - -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 -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. - - - -Contents: - -.. toctree:: - :maxdepth: 2 - - usage/first_steps - usage/markdown - usage/project_settings - usage/roadmap - usage/using_doc - usage/using_webhooks - usage/ticket_templates - usage/pr_custom_page - usage/theming - usage/upgrade_db - usage/pagure_ci - usage/quick_replies - usage/troubleshooting diff --git a/doc/usage/index.rst b/doc/usage/index.rst new file mode 100644 index 0000000..df50011 --- /dev/null +++ b/doc/usage/index.rst @@ -0,0 +1,47 @@ +Usage +===== + +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 to the admins of the +project: + +* A git repository containing the source code, displayed in the main section + 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 + + +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 +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. + + + +Contents: + +.. toctree:: + :maxdepth: 2 + + first_steps + markdown + project_settings + roadmap + using_doc + using_webhooks + ticket_templates + pr_custom_page + theming + upgrade_db + pagure_ci + quick_replies + troubleshooting