eclipse-score / eclipse-score/docs-as-code

Add Sphinx json-schema extension

Abierto
#472 4 comentarios 0 reacciones 1 asignado Reclamado por @a-zw Ver en GitHub
Lenguaje dominante
Python
Estrellas
10
Forks
32
Merge medio
23 h 52 min
PR fusionados (30 d)
52

Descripción

### Feature Request / Modification Description

There has been a lot of repos that include a json-schema file that has some docs on what each field is
e.g :
[communication](https://github.com/eclipse-score/communication/blob/68150892507ed2644d91fb9bfa5e7c513f0e141c/score/mw/com/impl/configuration/mw_com_config_schema.json)
[lifecycle](https://github.com/eclipse-score/lifecycle/blob/65893bc2807e60f9a333f83354ce191282cd1372/src/launch_manager_daemon/config/config_schema/launch_manager.schema.json)
[log](https://github.com/eclipse-score/baselibs/blob/8cc55a97a772c217840bd7ea5a40789b250dd684/score/mw/log/configuration/schema/logging_schema.json)

In the user facing docs it's nice to also explain these fields and so there is duplication of information ([lifecycle config docs](https://github.com/eclipse-score/lifecycle/blob/65893bc2807e60f9a333f83354ce191282cd1372/src/launch_manager_daemon/config/config_schema/docs/launch_manager_configuration.rst#launch-manager-root-properties))

There exists an extension that given the json schema generates a table https://sphinx-jsonschema.readthedocs.io/en/latest/directive.html#an-example

Example with lifecycle docs:
Image

### Expected Changes ot work products

- [ ] Requirements
- [ ] Architecture
- [ ] Safety Analysis
- [ ] Security Analysis
- [ ] Detailed Design
- [ ] Implementation and Testing
- [ ] all

### Impact analysis

Docs are not required to use this extension so no impact

### Safety or Security relevance

- [x] none
- [ ] Safety relevant
- [ ] Security relevant

### Expected required ASIL classification

QM

### Expected Implementation Version (Release)

1.0

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.