chaoss / chaoss/grimoirelab-tutorial
Update tutorial with new TOC
- Lingua principale
- Ruby
- Stelle
- 30
- Fork
- 68
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
In #93, we decided on a new table of content for the tutorial.
This is the TOC proposal:
* Quick start
1. Download
2. Define analysis scope:
* Intro to `projects.json`
* Intro to `setup.cfg`
3. Deploy and run GrimoireLab
* GrimoireLab Architecture and Data Workflow
* Data Sources Management
* The `projects.json` file: projects, data sources & repositories
* Adding and removing projects, data sources & repositories
* Contributors information management
* Identities and profiles
* Merging, adding and removing identities to profiles
* Editing profiles information: affiliation management
* Adding and editing organizations information
* Dashboard and data visualization
* Public and private access
* Dashboard, panels and visualizations
* Filtering, querying and searching
* Panels customization
* Enriched indexes fields (name, type and description)
* Editing existing panels
* Creating new panels
* Editing existing visualizations
* Creating new visualizations
* Adding visualizations to panels
* Exporting and importing panels
* Customizing public dashboard
* Data Consumption through Elasticsearch REST API
* Platform management and monitoring
I expect that the TOC will evolve over time.
Initial work is in a branch at: https://github.com/chaoss/grimoirelab-tutorial/tree/agamotto
The TOC proposed above has been already set (https://github.com/chaoss/grimoirelab-tutorial/blob/agamotto/_data/sidebars/home_sidebar.yml)
Next steps is filling in the pages and creating a pull request to the master branch.
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia esaminando il TOC esistente in _data/sidebars/home_sidebar.yml e il lavoro iniziale nel branch agamotto. Usa le sezioni proposte per identificare le pagine dei tutorial che necessitano ancora di contenuti, quindi verifica che le pagine coprano gli argomenti elencati e crea una pull request destinata a master.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- elasticsearch
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100