Skip to content

Commit a422a75

Browse files
committed
Update and extend desing documents
1 parent 809d776 commit a422a75

File tree

5 files changed

+56
-3
lines changed

5 files changed

+56
-3
lines changed

doc/design/addendum.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
Addendums and Updates
2+
=====================
3+
4+
Nox as Task Executor and Task Creation
5+
--------------------------------------
6+
7+
Why Nox Was Chosen
8+
~~~~~~~~~~~~~~~~~~
9+
10+
Nox was initially selected as our task executor due to several reasons:
11+
12+
* **No Additional Languages Required**: There was no need to introduce extra programming languages or binaries, simplifying the development process.
13+
* **Python-based**: Being Python-based, Nox can be extended, understood by python devs and also can share code.
14+
* **Simplicity**: Nox is relatively "small" in functionality which makes it somewhat simple to use.
15+
16+
Although today, other options like `invoke` could be consider or used as a replacement, Nox still is working for use even though there are some rough edges.
17+
18+
Naming of Tasks and Grouping
19+
----------------------------
20+
21+
Task Grouping with Nox
22+
~~~~~~~~~~~~~~~~~~~~~~
23+
24+
Since Nox doesn't natively support task grouping like Invoke, we need a strategy to clearly distinguish commands. We will adopt a naming convention to indicate grouping within the CLI.
25+
26+
Groups will be separated using a :code:`:` (colon) because :code:`-` (dash) might already be used within task names.
27+
28+
Examples
29+
++++++++
30+
31+
**Task Names:**
32+
33+
* :code:`docs:clean`
34+
* :code:`docs:build`
35+
* :code:`docs:open`
36+
37+
38+
**CLI Execution:** :code:`nox -s docs:clean docs:build docs:open`
39+
40+
This approach helps in organizing tasks logically and makes it easier for developers to identify and execute related commands.
41+
42+
By following these guidelines, we ensure a structured and comprehensible task management system, facilitating smoother development and maintenance.
File renamed without changes.

doc/design/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _design_documents:
2+
3+
4+
:octicon:`repo` Desing Documents
5+
================================
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
design
11+
addendum

doc/developer_guide/developer_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
.. toctree::
88
:maxdepth: 2
99

10-
../design
10+
../design/index
1111
development
1212
plugins
1313
modules/modules

doc/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ Documentation of the Exasol-Toolbox
4949

5050
Detailed descriptions, syntax, and usage examples for the API provided by this project.
5151

52-
.. grid-item-card:: :octicon:`repo` Design Document
53-
:link: design_document
52+
.. grid-item-card:: :octicon:`repo` Design Documents
53+
:link: design_documents
5454
:link-type: ref
5555

5656
Document outlining the architectural and design principles and decisions in this project.

0 commit comments

Comments
 (0)