Skip to content

Commit a67ba16

Browse files
signekbpre-commit-ci[bot]lwjohnst86
authored
docs: 📝 update architecture naming section (#118)
# Description This updates the naming section in the design docs. Closes #104 Related to #46 Needs an in-depth review. ## Checklist - [X] Formatted Markdown - [X] Ran `just run-all` --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Luke W. Johnston <[email protected]>
1 parent 580c0f1 commit a67ba16

File tree

1 file changed

+32
-37
lines changed

1 file changed

+32
-37
lines changed

docs/design/architecture.qmd

Lines changed: 32 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,38 @@ This section describes the different users we expect and design for:
2929
add custom checks or ignore certain checks to fit the specific needs
3030
of the project.
3131

32+
## Naming
33+
34+
This section contains a naming scheme for `check-datapackage` that is
35+
inspired by the [Data Package standard](https://datapackage.org/).
36+
37+
Overall, we follow the Data Package terminology where possible to keep
38+
things consistent. However, we also introduce some new terms and
39+
concepts specific to `check-datapackage`. The main objects and actions
40+
used throughout the package can be found in the tables below.
41+
42+
### Objects
43+
44+
| Object | Description |
45+
|----------------------------|--------------------------------------------|
46+
| package | A Data Package that contains a collection of related data resources and descriptor(s). |
47+
| descriptor | A standalone and complete metadata structure contained in a JSON file, for example, in `datapackage.json`. |
48+
| properties | Metadata fields (name-value pairs) of a descriptor loaded as a Python dictionary. This can be a subset of the original descriptor or the entire structure. |
49+
| schema | The JSON schema defining the Data Package standard. |
50+
| config | An object containing settings for modifying the behaviour and output of the check mechanism. |
51+
52+
: Objects used throughout `check-datapackage`.
53+
54+
### Actions
55+
56+
| Action | Description |
57+
|----------------------------|--------------------------------------------|
58+
| check | Check that a descriptor conforms to the Data Package standard. |
59+
| explain | Explain issues flagged by the check action in more detail using non-technical language. |
60+
| read | Read various files, such as a Data Package descriptor or a configuration file. |
61+
62+
: Actions that `check-datapackage` can perform.
63+
3264
## C4 Models
3365

3466
This section contains the [C4 Models](https://c4model.com/) for
@@ -96,40 +128,3 @@ flowchart LR
96128
ext_dp_schema --> check
97129
in_dp_json --> check
98130
```
99-
100-
## Naming
101-
102-
This section contains a naming scheme for `check-datapackage` that is
103-
inspired by the [Data Package standard](https://datapackage.org/).
104-
105-
Following Data Package terminology, we simplify "data package" to
106-
"package" and "data resource" to "resource". The Data Package standard
107-
calls a standalone and complete metadata structure
108-
["descriptor"](https://datapackage.org/standard/glossary/#descriptor).
109-
Descriptors are JSON objects contained in JSON files (e.g.,
110-
`datapackage.json` contains the Data Package descriptor). We adopt this
111-
usage, but may also use the word "properties" to refer to the metadata
112-
as a whole.
113-
114-
### Objects
115-
116-
| Object | Description |
117-
|----------------------------|--------------------------------------------|
118-
| package | A Data Package that contains a collection of related data resources and properties. |
119-
| resource | A single data file within a package including its properties. |
120-
| descriptor | The standalone and complete metadata structure contained in a JSON file, for example, in `datapackage.json`. |
121-
| properties | Individual elements of the metadata structure or the structure as a whole. |
122-
| standard | The JSON schema defining the Data Package standard. |
123-
| config | An object containing settings for modifying the behaviour and output of the check mechanism. |
124-
125-
: Objects used throughout `check-datapackage`.
126-
127-
### Actions
128-
129-
| Action | Description |
130-
|----------------------------|--------------------------------------------|
131-
| check | Check that a descriptor conforms to the Data Package standard. |
132-
| explain | Explain issues flagged by the check mechanism in more detail using non-technical language. |
133-
| read | Read various files, such as the Data Package descriptor or configuration files. |
134-
135-
: Actions that `check-datapackage` can perform.

0 commit comments

Comments
 (0)