index.rst 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. Usage
  2. =====
  3. Using pagure should come fairly easily, especially to people already used
  4. to forges such as GitHub or GitLab. There are however some tips and tricks
  5. which can be useful to know and that this section of the doc covers.
  6. One of the major difference with GitHub and GitLab is that for each project
  7. on pagure, four git repositories are made available:
  8. * A git repository containing the source code, displayed in the main section
  9. of the pagure project.
  10. * A git repository for the documentation
  11. * A git repository for the issues and their metadata
  12. * A git repository for the metadata for pull-requests
  13. Issues and pull-requests repositories contain the meta-data (comments,
  14. notifications, assignee...) from the issues and pull-request. They are are
  15. not public and only available to admins and committers of the project,
  16. since they may contain private information.
  17. You can use these repositories for offline access to your tickets or
  18. pull-requests (the `pag-off <https://pagure.io/pag-off>`_ project for example
  19. relies on a local copy of the issue git repository). They are designed to
  20. allow you to have full access to all the data about your project.
  21. One of the original idea was also to allow syncing a project between multiple
  22. pagure instances by syncing these git repositories between the instances.
  23. You can find the URLs to access or clone these git repositories on the
  24. overview page of the project. On the top right of the page, in the drop-down
  25. menu entitled ``Clone``. Beware that if documentation, the issue tracker or
  26. the pull-requests are disabled on the project, the corresponding URL will
  27. not be shown.
  28. Contents:
  29. .. toctree::
  30. :maxdepth: 2
  31. first_steps
  32. forks
  33. read_only
  34. pull_requests
  35. markdown
  36. project_settings
  37. project_acls
  38. roadmap
  39. flags
  40. magic_words
  41. using_doc
  42. using_webhooks
  43. ticket_templates
  44. pr_custom_page
  45. theming
  46. upgrade_db
  47. pagure_ci
  48. quick_replies
  49. troubleshooting
  50. tips_tricks
  51. Pagure API
  52. ----------
  53. The API documentation can be found at `https://pagure.io/api/0/ <https://pagure.io/api/0/>`_
  54. or in ``/api/0/`` of you local pagure instance.