75 lines
1.8 KiB
Markdown
75 lines
1.8 KiB
Markdown
# 🚀 TP Docs - Documentazione Tecnica
|
|
|
|
Benvenuto nel progetto **TP Docs**, il sito di documentazione ufficiale per il nostro team di sviluppo!
|
|
|
|
Questo progetto è costruito con [Docusaurus](https://docusaurus.io/), uno strumento moderno per creare siti di documentazione veloci, belli e facili da mantenere.
|
|
|
|
---
|
|
|
|
## 👩💻 Guida per gli Sviluppatori
|
|
|
|
Se sei uno sviluppatore, questa sezione ti spiega come collaborare in modo ordinato e sicuro usando Git e GitLab.
|
|
|
|
### Requisiti
|
|
|
|
- Git installato sul tuo computer
|
|
- Accesso al repository (chiedi al maintainer)
|
|
- Account GitLab attivo
|
|
|
|
### Passaggi rapidi
|
|
|
|
1. **Clona il repository**
|
|
|
|
```bash
|
|
git clone https://gitlab.tecnopackspa.it/tp-docs/tp-docs.git
|
|
cd tp-docs
|
|
```
|
|
|
|
2. **Crea un branch per il tuo lavoro**
|
|
|
|
Non lavorare mai direttamente su `master`.
|
|
|
|
```bash
|
|
git checkout -b feature/nome-funzionalità
|
|
```
|
|
|
|
3. **Modifica, committa e push**
|
|
|
|
Lavora sul codice, aggiungi le modifiche e crea commit chiari.
|
|
|
|
4. **Crea una Merge Request (MR)**
|
|
|
|
Spingi il branch su GitLab e apri una MR per la revisione.
|
|
|
|
---
|
|
|
|
## 📚 Documentazione Completa
|
|
|
|
Per approfondire, consulta le guide dettagliate:
|
|
|
|
- [Guida per gli sviluppatori](project_documentation/DEV_GUIDE.md)
|
|
- [Guida per i maintainer](project_documentation/MAINTAINER_GUIDE.md)
|
|
|
|
---
|
|
|
|
## 🔧 Come contribuire
|
|
|
|
Vuoi contribuire a migliorare la documentazione? Ottimo!
|
|
Segui la [guida per gli sviluppatori](project_documentation/DEV_GUIDE.md), apri una MR e partecipa alla crescita del progetto.
|
|
|
|
---
|
|
|
|
## 🌐 Sito Web
|
|
|
|
Il sito di documentazione è disponibile all'indirizzo:
|
|
[https://docs.gitlab.tecnopackspa.it](http://172.17.1.43/)
|
|
---
|
|
|
|
## 🤝 Contatti
|
|
|
|
Per supporto o domande, contatta il maintainer del progetto.
|
|
|
|
---
|
|
|
|
*Buona documentazione e buon lavoro! 🚀*
|