[Feature]: Getting documentation about the relationships between the repos

Aperta
#3 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
58/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Inizia esaminando il README dell'organizzazione DIRACGrid, nonché il CONTRIBUTING.md di DIRAC e le pagine docs/dev di diracx a cui si fa riferimento. Usa i diagrammi Mermaid proposti come base per documentare le relazioni tra i repository e lo stato dei contributi, quindi collega le informazioni sull'architettura dal README dell'organizzazione e dalla documentazione di DIRAC e diracx. Il lavoro è completato quando i nuovi contributori possono trovare e capire facilmente come si integrano tra loro i progetti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement
User Story

As a newcomer, I want to quickly understand the relationships between all the projects within the DIRACGrid organization because there are many of them, so that I can quickly understand the status of the project and where I could contribute the most.

Feature Description

Having mermaid diagram showing what belongs to DIRAC and diracx and both and their state could be useful (but would require manual updates of course).

For context, this came to me a few months ago when I tried to add a contribution in another organization with many repos and I wasn't completely sure where to add my contribution (in the end I targeted the wrong repo). Note: this organization might have been less clear to navigate than the DIRACGrid one, but I am way to biased to tell.

The README of the organization could be used but it would be probably too much content.
Adding the architecture in both DIRAC and diracx documentation and reference them from the README could be a good trade off.

Definition of Done
  • easily find information about the relationships of the projects
Alternatives Considered

No response

Related Issues

No response

Additional Context

Here is a proposal:

How the repositories fit together

Node colours show how open each project is to contributions:

🟩 Features welcome — actively developed, new features accepted ·
🟧 Bug fixes only — maintained, no new features ·
🟥 Frozen — not accepting external contributions ·
Supporting — infra/tooling maintained by the core team; touch as needed

Each codebase has its own contributing guide —
DIRAC and
DiracX differ; new development happens in DiracX.

DIRAC — production stack

flowchart TB
    WEBAPP["<b>WebAppDIRAC</b><br/>ExtJS web portal"]
    DIRAC["<b>DIRAC</b><br/>core"]
    RES["<b>DIRACWebAppResources</b><br/>static assets"]
    PKG["<b>dirac-webapp-packaging</b><br/>JS build backend"]
    TM2["<b>tornado_m2crypto</b><br/>cert-based transport"]
    TORN["<b>tornado (fork)</b><br/>patched framework"]
    MGMT["<b>management</b><br/>release & CI images"]
    PILOT["<b>Pilot</b><br/>pilot jobs"]
    DB12["<b>DB12</b><br/>node benchmark"]
    OS["<b>DIRACOS2</b><br/>runtime / deps"]
    CFG["<b>diraccfg</b><br/>cfg parser"]

    WEBAPP -->|extends| DIRAC
    RES -->|assets for| WEBAPP
    PKG -->|builds| WEBAPP
    TM2 -->|secures| DIRAC
    TM2 -->|requires| TORN
    MGMT -.->|builds & releases| DIRAC
    PILOT -->|pulls jobs from| DIRAC
    PILOT -->|benchmarks via| DB12
    OS -->|runtime for| DIRAC
    CFG -->|parses CS of| DIRAC

    classDef bugfix fill:#ffe0b2,stroke:#e65100,color:#000;
    classDef frozen fill:#ffcdd2,stroke:#c62828,color:#000;
    classDef support fill:#eceff1,stroke:#607d8b,color:#000;
    class DIRAC,WEBAPP bugfix;
    class TORN,TM2 frozen;
    class RES,PKG,MGMT,PILOT,DB12,OS,CFG support;

DiracX — next-generation stack

flowchart TB
    MONO["<b>diracx</b><br/>next-gen core"]
    WEB["<b>diracx-web</b><br/>React UI"]
    CHARTS["<b>diracx-charts</b><br/>Helm chart & demo"]
    IMAGES["<b>container-images</b><br/>secret-generation"]
    SIGN["<b>signurlarity</b><br/>S3 presigned URLs"]
    DOCS["<b>mkdocs-diracx-plugin</b><br/>docs aggregation"]

    WEB -->|REST| MONO
    CHARTS -->|deploys| MONO
    CHARTS -->|deploys| WEB
    CHARTS -->|uses| IMAGES
    SIGN -.->|sandbox store| MONO
    DOCS -.->|aggregates docs| MONO

    classDef features fill:#c8e6c9,stroke:#2e7d32,color:#000;
    classDef frozen fill:#ffcdd2,stroke:#c62828,color:#000;
    classDef support fill:#eceff1,stroke:#607d8b,color:#000;
    class MONO features;
    class WEB frozen;
    class CHARTS,IMAGES,SIGN,DOCS support;
Lingua principale
Nessun dato sulla lingua
Stelle
0
Fork
1
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.