1
0
mirror of https://gitlab.com/free_zed/free_zed.gitlab.io.git synced 2024-06-09 11:52:31 +00:00
free_zed.gitlab.io/content/gitlab-team-organisation-code-reuse-documentation-and-collaboraton-en.md
2021-12-01 23:23:47 +01:00

59 lines
2.7 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Title: Get organized with GitLab
Date: 2020-09-15 01:10
Summary: The goal of this group is to provide an organization that facilitates code reuse, documentation and collaboration
Category: Réalisations
Tags: forga, django, python, packaging, pip, ci, cd, git, dry, gitlab, agile, méthode, collectif, dev, devops, statique, gitlab-pages, web, mkdocs
Status: Published
Lang: en
Slug: gitlab-team-organisation-code-reuse-documentation-and-collaboraton
💡 What's the idea?
==================
The [`forga`](https://gitlab.com/forga/) group ([`https://gitlab.com/forga/`](https://gitlab.com/forga/)) aims to provide an organization that facilitates:
- ♻️ the reuse of code;
- 📝 documentation (of code or anything else);
- 🤝 collaboration;
[![Tree view for `forga` group]({static}/img/forga-tree-s.jpg)](https://gitlab.com/forga/)
It uses the [groups](https://docs.gitlab.com/ce/user/group/)/[subgroups](https://docs.gitlab.com/ce/user/group/subgroups/), [pages](https://about.gitlab.com/stages-devops-lifecycle/pages/), and other _GitLab_ features to enable organization:
- of `git` repositories grouped by usage (in a tree structure);
- batch user access management;
- semantic URLs for static documentation web pages;
The content deals with development in a Python & Django context, but any kind of language/_framework_ will find its place there.
⚠️ Warning
----------
It is an experimental project under development.
Some aspects have been set up in a professional context, others are personal experiments.
📦 What's in it?
=================
1. an [mentorship tool](https://gitlab.com/forga/process/fr/embarquement/) for new users (French version for Python/Django/UML);
1. a [single source of documentation](https://forga.gitlab.io/process/fr/manuel/_le Manuel_ (French version);
1. some [Django](https://www.djangoproject.com/) packages:
- a [bootstrap project](https://gitlab.com/forga/tool/django/core/);
- an [application directly installable with `pip`](https://gitlab.com/forga/tool/django/one_to_one/);
1. a [customer project](https://gitlab.com/forga/customer/acme/) reusing the Django packages above;
1. [third-party projects](https://gitlab.com/forga/devel/third-party/) used internally;
And if not, you can always [visit the group URL](https://gitlab.com/forga/) and scroll down the contents of the subgroups to get an idea.
🤝 Want to contribute?
======================
With pleasure!
There are some conventions ([git](https://forga.gitlab.io/process/fr/manuel/convention/git/) & [python](https://forga.gitlab.io/process/fr/manuel/convention/python/)) presented in [the manual](https://forga.gitlab.io/process/fr/manuel/) and a [code of conduct](https://forga.gitlab.io/process/fr/manuel/human/code-of-conduct/).