grimoirelab-tutorial icon indicating copy to clipboard operation
grimoirelab-tutorial copied to clipboard

Published 20 hours ago • verified publisher icon chaoss

Set a proper structure for the tutorial

Open VSevagen opened this issue 3 years ago • 1 comments

At the moment, the updated docs can be found within the docs/ folder. I think we can add the other docs within this directory and update the information or remove the deprecated information. When building the docs, we can see that the tutorial structure is kind of messy so we can define a proper structure here and implement it once decided.

VSevagen avatar Feb 24 '22 16:02 VSevagen

We have below the tentative TOC for the current tutorial. Every update to the docs can be done according to this TOC or any TOC discussed.

Table of content

  1. Getting started
    • Setup
      • Via docker-compose
      • Via docker
    • Add your data sources (projects.json, setup.cfg)
    • Run GrimoireLab
    • Troubleshooting
  2. Data Sources
    • Supported Data sources
    • What is project.json and setup.cfg ?
    • How to add data sources ?
    • Troubleshooting
  3. Dashboard
    • Dashboard overview
    • Brief about functions (Dev tools, Visualize etc…)
    • Customize a dashboard
    • How to filter data ?
    • How to query data ?
    • Navigate through various dashboards
    • Difference between public and private access.
    • Troubleshooting
  4. Panels
    • What is a panel ?
    • Edit an existing panel
    • Create a new panel
      • How to choose a visualization type ?
      • How to choose an index pattern ?
      • How to create the visualization ?
        • What are Metrics and Buckets ?
      • Add panel to dashboard
      • Remove a panel from dashboard
      • Re-arrange panels in dashboard
      • Troubleshooting
  5. Contributors Information Management (SortingHat)
    • What is SortingHat and its purpose ?
    • How to associate developers to org ?
    • Further functionalities of SortingHat
    • What are identities and Profiles ?
    • Adding, removing and merging profiles
    • Adding and editing organisation details
    • Editing org and profile details
    • Troubleshooting
  6. Contribution Guidelines
  7. About GrimoireLab
    • Basic overview of each component ( concise and short text)
    • Basic setup information for individual component
    • Component Interaction ( how each component interact with each other)

VSevagen avatar Feb 26 '22 17:02 VSevagen