User manual¶
This manual supports you from your first connection to a gitrust instance to complete autonomy: pushing code, collaborating via pull requests, managing issues and automating your workflows with integrated CI. You don't need to administer or understand the internal architecture — this manual only assumes that you know how to use Git from the command line.
Learning path¶
The manual is structured as a progressive course of 4 tutorials. Each tutorial leaves you in a stable, verified state before moving on to the next one. The help provided goes back a step at each step (from full copy and paste to independent composition).
graph LR
A[Compte créé] --> B[01-premier-pas
20 min]
B --> C[02-cloner-pousser
25 min]
C --> D[03-collaborer
25 min]
D --> E[04-automatiser-ci
20 min]
E --> F[Utilisateur autonome]
Checkpoint de parcours : avant de passer au tutoriel 02, tu dois pouvoir te connecter à gitrust, voir ton dépôt dans l'interface et l'accès SSH configuré. Si ce n'est pas le cas, relis le tutoriel 01.
Checkpoint de parcours : avant le tutoriel 03, tu dois avoir poussé au moins un commit sur ta branche via SSH. Si ce n'est pas le cas, relis le tutoriel 02.
Checkpoint de parcours : avant le tutoriel 04, tu dois avoir ouvert et mergé une pull request. Si ce n'est pas le cas, relis le tutoriel 03.
Tutorials — learn by doing¶
The tutorials are guided step-by-step with expected verbatim output. Follow them in order — each assumes the previous one completed.
- 01 — First steps: 2FA, SSH key, first deposit — ~20 min
- 02 — Clone and push code — ~25 min
- 03 — Collaborate: teams, issues, pull requests — ~25 min
- 04 — Automate with CI — ~20 min
How-to — recipes for common tasks¶
How-tos answer “how to do X” without any substantive explanation. You can view them in any order depending on your immediate need.
These guides assume that you have followed the tutorial path. They don't repeat basic steps.
- Manage your SSH keys
- Configure 2FA
- Create a Personal Access Token
- Manage teams and permissions
- Open a pull request
- Merge: fast-forward, squash, merge commit
- Use hierarchical labels
- Import an external repository
- Consult the SBOM of your project
Reference — exact technical information¶
The reference is intended for occasional consultation, not for linear reading. It documents exact formats, patterns and behaviors.
- Permissions model (4 roles)
- REST API v1 — authentication, pagination, error codes
- YAML Schema
.gitrust-ci.yml(Easy Mode) - Supported Markdown syntax
- Notifications: SSE, email, preferences
Explanation — understand the why¶
Les explanations t'aident à construire des modèles mentaux durables. Lis-les quand tu veux comprendre pourquoi gitrust fonctionne ainsi, pas seulement comment.