Skip to content

Commit ebcbfac

Browse files
authored
Merge branch 'main' into docs/technical_restrictions
2 parents 72062d8 + 7dbb0e4 commit ebcbfac

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/release_workflow.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@ Step-by-Step Guide
1010

1111
1. Python Package Implementation
1212
--------------------------------
13-
* **Starting Point:** The journey begins with the implementation of the `BO4E data model as a Python package <https://github.com/bo4e/BO4E-python/>`_.
13+
* **Starting Point:** The journey begins with the implementation of the `BO4E data model as a Python package <https://github.com/bo4e/BO4E-python/>`__.
1414

1515
2. Release and Schema Generation
1616
--------------------------------
1717
* **Automatic Generation:** Upon releasing a new version of this Python package, a GitHub action automatically triggers.
1818
* **JSON Schemas Creation:** This action generates JSON schemas, which are essential blueprints of the data model.
19-
* **Storage:** These schemas are then stored in a dedicated repository, known as the `BO4E-Schemas Repository <https://github.com/bo4e/BO4E-Schemas>`_.
19+
* **Storage:** These schemas are then stored in a dedicated repository, known as the `BO4E-Schemas Repository <https://github.com/bo4e/BO4E-Schemas>`__.
2020

21-
3. Optional Customization (BO4E-Schema-Tool)
21+
3. Optional Customization (BO4E-CLI)
2222
--------------------------------------------
2323
* **Flexibility in Data Fields:** Initially, the JSON schemas contain only optional fields.
24-
* **Setting Required Fields:** If you need to designate certain fields as mandatory, you can use the `BO4E-Schema-Tool Repository <https://github.com/bo4e/BO4E-Schema-Tool>`_.
25-
* **Tool Functionality:** This repository houses a command-line interface (CLI) tool that assists in updating the JSON schema files to define required fields.
24+
* **Setting Required Fields:** If you need to designate certain fields as mandatory, you can use the `BO4E-CLI <https://github.com/bo4e/BO4E-CLI?tab=readme-ov-file#bo4e-edit>`__.
25+
* **More flexibility for your use-case:** Besides the required fields, the BO4E-CLI can do a lot more non-critical customization. I.e. the edits are only additive.
2626

27-
4. Code Generation (BO4E-Python-Generator)
27+
4. Code Generation (BO4E-CLI)
2828
------------------------------------------
2929
* **Finalizing JSON Schemas:** Once you have the final version of the JSON schema files, it's time to generate code.
30-
* **Pydantic Classes Creation:** Utilize tools like the `BO4E-Python-Generator <https://github.com/bo4e/BO4E-Python-Generator>`_, another CLI tool, to create Pydantic classes from the JSON schemas.
30+
* **Pydantic Classes Creation:** Use the same `BO4E-CLI <https://github.com/bo4e/BO4E-CLI?tab=readme-ov-file#bo4e-generate>`__ to create Pydantic classes from the JSON schemas.
3131

3232
5. Ready to Use
3333
---------------

0 commit comments

Comments
 (0)