diff --git a/.github/workflows/pr-preview-build.yml b/.github/workflows/pr-preview-build.yml index b6e271b..b213e2a 100644 --- a/.github/workflows/pr-preview-build.yml +++ b/.github/workflows/pr-preview-build.yml @@ -84,7 +84,7 @@ jobs: mkdir -p site if [ "${ACTION}" != "closed" ]; then # Move built site contents into the artifact staging directory, - # excluding git/github metadata that should not be deployed. + # excluding git/github metadata that SHOULD not be deployed. shopt -s dotglob for item in *; do case "$item" in diff --git a/.gitignore b/.gitignore index ad2063b..e1bc39d 100644 --- a/.gitignore +++ b/.gitignore @@ -44,8 +44,8 @@ .idea/**/libraries # Gradle and Maven with auto-import -# When using Gradle or Maven with auto-import, you should exclude module files, -# since they will be recreated, and may cause churn. Uncomment if using +# When using Gradle or Maven with auto-import, you SHOULD exclude module files, +# since they will be recreated, and MAY cause churn. Uncomment if using # auto-import. # .idea/artifacts # .idea/compiler.xml @@ -539,7 +539,7 @@ $RECYCLE.BIN/ .AppleDouble .LSOverride -# Icon must end with two \r +# Icon MUST end with two \r Icon # Thumbnails @@ -560,4 +560,3 @@ Icon Network Trash Folder Temporary Items .apdisk - diff --git a/README.md b/README.md index 45b5c4f..3e76f45 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,11 @@ coherent rendered document. This specification is developed under the governance of the **FDO Forum**. -- The document may evolve over time -- Not all sections may be complete at all times +- The document MAY evolve over time +- Not all sections MAY be complete at all times - Changes are discussed and reviewed through the repository’s issue and pull request process -Unless explicitly stated otherwise, the content in this repository should be considered **work in progress**. +Unless explicitly stated otherwise, the content in this repository SHOULD be considered **work in progress**. ## Repository Structure @@ -73,7 +73,7 @@ Typical contributions include: Please read the policy on how to contribute: https://github.com/fairdo-org/fdo-architecture-spec/blob/main/Contribution-Specification-Development-Policy-v1.0.pdf -Contributions should follow the architectural scope and terminology defined by the FDO Forum. +Contributions SHOULD follow the architectural scope and terminology defined by the FDO Forum. ## Governance diff --git a/img/FDO-basic-concept.svg b/img/FDO-basic-concept.svg index fe4558d..9b47fd5 100644 --- a/img/FDO-basic-concept.svg +++ b/img/FDO-basic-concept.svg @@ -1,4 +1,4 @@ -
0.FDO/Profile
0.FDO/Type
0.FDO/Data
<Type of the FDO>
<Ref to FDO Profile>
<Ref to Data>
Attribute definition PIDs
Attribute values
FDO Record of <PID> 
<PID>
resolves to
0.FDO/License
<License of FDO>
defining 0.FDO/License:
- label: "License"
- description: "License of    an FDO"
- cardinality: 0-1
- syntax: one of: Apache,    CC-BY, MIT, ...
-  ...
FDO Attribute definition
resolves to
more attributes
...
...
Data bit-sequence 
reference to
Registry
Registry
FDO Profile
FDO must contain the following attributes:
- 0.FDO/Type
- 0.FDO/Profile
- 0.FDO/Data
- 0.FDO/License
-  ...
resolves to
Data Storage
\ No newline at end of file +
0.FDO/Profile
0.FDO/Type
0.FDO/Data
<Type of the FDO>
<Ref to FDO Profile>
<Ref to Data>
Attribute definition PIDs
Attribute values
FDO Record of <PID> 
<PID>
resolves to
0.FDO/License
<License of FDO>
defining 0.FDO/License:
- label: "License"
- description: "License of    an FDO"
- cardinality: 0-1
- syntax: one of: Apache,    CC-BY, MIT, ...
-  ...
FDO Attribute definition
resolves to
more attributes
...
...
Data bit-sequence 
reference to
Registry
Registry
FDO Profile
FDO MUST contain the following attributes:
- 0.FDO/Type
- 0.FDO/Profile
- 0.FDO/Data
- 0.FDO/License
-  ...
resolves to
Data Storage
diff --git a/index.html b/index.html index cfc5f48..73bc7a4 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,8 @@ - FAIR Digital Objects Architecture Specification DRAFT + + FAIR Digital Objects Architecture Specification