Blame doc/usage/index.rst

Pierre-Yves Chibon 04619c
Usage
Pierre-Yves Chibon 04619c
=====
Pierre-Yves Chibon 04619c
Pierre-Yves Chibon 04619c
Using pagure should come fairly easily, especially to people already used
Pierre-Yves Chibon 04619c
to forges such as GitHub or GitLab. There are however some tips and tricks
Pierre-Yves Chibon 04619c
which can be useful to know and that this section of the doc covers.
Pierre-Yves Chibon 04619c
Pierre-Yves Chibon 068134
Pierre-Yves Chibon 068134
One of the major difference with GitHub and GitLab is that for each project
Anatoli Babenia 7058f6
on pagure, four git repositories are made available:
Pierre-Yves Chibon 068134
Pierre-Yves Chibon 068134
* A git repository containing the source code, displayed in the main section
Pierre-Yves Chibon 068134
  of the pagure project.
Pierre-Yves Chibon 068134
* A git repository for the documentation
Pierre-Yves Chibon 068134
* A git repository for the issues and their metadata
Pierre-Yves Chibon 068134
* A git repository for the metadata for pull-requests
Pierre-Yves Chibon 068134
Pierre-Yves Chibon 068134
Pierre-Yves Chibon 13832f
Issues and pull-requests repositories contain the meta-data (comments,
Pierre-Yves Chibon 13832f
notifications, assignee...) from the issues and pull-request. They are are
Pierre-Yves Chibon 13832f
not public and only available to admins and committers of the project,
Pierre-Yves Chibon 13832f
since they may contain private information.
Pierre-Yves Chibon 13832f
Pierre-Yves Chibon 13832f
You can use these repositories for offline access to your tickets or
Pierre-Yves Chibon 13832f
pull-requests (the `pag-off <https: pag-off="" pagure.io="">`_ project for example</https:>
Pierre-Yves Chibon 13832f
relies on a local copy of the issue git repository). They are designed to
Pierre-Yves Chibon 13832f
allow you to have full access to all the data about your project.
Pierre-Yves Chibon 13832f
One of the original idea was also to allow syncing a project between multiple
Pierre-Yves Chibon 13832f
pagure instances by syncing these git repositories between the instances.
Anatoli Babenia 7058f6
Pierre-Yves Chibon 068134
You can find the URLs to access or clone these git repositories on the
Pierre-Yves Chibon 13832f
overview page of the project. On the top right of the page, in the drop-down
Pierre-Yves Chibon 13832f
menu entitled ``Clone``. Beware that if documentation, the issue tracker or
Pierre-Yves Chibon 13832f
the pull-requests are disabled on the project, the corresponding URL will
Pierre-Yves Chibon 13832f
not be shown.
Pierre-Yves Chibon 068134
Pierre-Yves Chibon 068134
Pierre-Yves Chibon 04619c
Contents:
Pierre-Yves Chibon 04619c
Pierre-Yves Chibon 04619c
.. toctree::
Pierre-Yves Chibon 04619c
   :maxdepth: 2
Pierre-Yves Chibon 04619c
Jeremy Cline 226c43
   first_steps
Jeremy Cline 0b19fd
   forks
Pierre-Yves Chibon ccbef1
   read_only
Jeremy Cline 0b19fd
   pull_requests
Jeremy Cline 226c43
   markdown
Jeremy Cline 226c43
   project_settings
Pierre-Yves Chibon 1fadc0
   project_acls
Jeremy Cline 226c43
   roadmap
Pierre-Yves Chibon 1ffce3
   flags
Jeremy Cline 226c43
   using_doc
Jeremy Cline 226c43
   using_webhooks
Jeremy Cline 226c43
   ticket_templates
Jeremy Cline 226c43
   pr_custom_page
Jeremy Cline 226c43
   theming
Jeremy Cline 226c43
   upgrade_db
Jeremy Cline 226c43
   pagure_ci
Jeremy Cline 226c43
   quick_replies
Jeremy Cline 226c43
   troubleshooting
Eashan c8383d
   tips_tricks
Pierre-Yves Chibon 7766da
Pierre-Yves Chibon 7766da
Pierre-Yves Chibon 7766da
Pagure API
Pierre-Yves Chibon 7766da
----------
Pierre-Yves Chibon 7766da
Pierre-Yves Chibon ccbef1
The API documentation can be found at `https://pagure.io/api/0/ <https: 0="" api="" pagure.io="">`_</https:>
Pierre-Yves Chibon 7766da
or in ``/api/0/`` of you local pagure instance.