Merge pull request #2 from duprijil/feature/TED-1423

Feature/ted 1423
OP-TED · Sep 22, 2023 · 001cfd1 · 001cfd1
2 parents 1ae529e + aa3821a
commit 001cfd1
Show file tree

Hide file tree

Showing 17 changed files with 78 additions and 236 deletions.
diff --git a/.gitignore b/.gitignore
@@ -118,4 +118,4 @@ package.json
 .limes/*
 *.ser
 .DS_Store
-.scannerwork/*
+.scannerwork/*
diff --git a/docs/antora/modules/ROOT/nav.adoc b/docs/antora/modules/ROOT/nav.adoc
@@ -1,10 +1,27 @@
-.Using TED Data
-** xref:ted_data/jupyter_notebook.adoc[Jupyter Notebook]
-** xref:ted_data/ms_excell.adoc[MS Excel]
-
-.Using Mapping Suites
-** xref:repository-structure.adoc[Repository structure]
-** xref:mapping-suite-structure.adoc[Mapping suite anatomy]
-** xref:code-list-resources.adoc[Code list mappings]
-** xref:preparing-test-data.adoc[Data samples]
-** xref:versioning.adoc[Versioning]
+* xref:index.adoc[Home]
+    ** What is TED SWS
+    ** What is sample app?
+    ** What is mapping?
+    ** How to use TED SWS
+    ** What y’ll find in this documentation
+    ** How to contribute to TED SWS
+
+* xref:mapping_suite/index.adoc[Mapping Suites]
+    ** Getting started
+    ** Who are these docs written for
+    ** Glossary
+    ** Assumptions we make about the skills of the reader
+        *** Prerequisites
+    ** what the user can achieve through these pages
+    ** xref:mapping_suite/repository-structure.adoc[Repository structure]
+    ** xref:mapping_suite/mapping-suite-structure.adoc[Mapping suite anatomy]
+    ** xref:mapping_suite/code-list-resources.adoc[Code list mappings]
+    ** xref:mapping_suite/preparing-test-data.adoc[Data samples]
+    ** xref:mapping_suite/versioning.adoc[Versioning]
+    ** References
+
+* xref:sample_app/index.adoc[TED Data Sample application]
+    ** xref:sample_app/jupyter_notebook.adoc[Jupyter Notebook]
+    ** xref:sample_app/ms_excell.adoc[MS Excel]
+
+
diff --git a/docs/antora/modules/ROOT/pages/index.adoc b/docs/antora/modules/ROOT/pages/index.adoc
@@ -1,3 +1,22 @@
-= TED SWS Documentation
+= TED-RDF Conversion Pipeline Documentation
+
+The TED-RDF Conversion Pipeline, is part of the TED Semantic Web Services (TED-SWS system) and provides tools an infrastructure to convert TED notices available in XML format into RDF. This conversion pipeline is designed to work with the https://docs.ted.europa.eu/rdf-mapping/index.html[TED-SWS Mapping Suites] - self containing packages with transformation rules and resources.
+
+== What is TED SWS
+
+
+== What is sample app?
+
+
+== What is mapping?
+
+
+== How to use TED SWS
+
+
+== What y’ll find in this documentation
+
+
+== How to contribute to TED SWS
+
 
-TED Semantic Web Services is a solution for transforming TED notices into Linked Open Data (LOD) representation based on eProcurement Ontology (ePO).
diff --git a/...dules/ROOT/pages/code-list-resources.adoc → ...es/mapping_suite/code-list-resources.adoc b/...dules/ROOT/pages/code-list-resources.adoc → ...es/mapping_suite/code-list-resources.adoc
diff --git a/docs/antora/modules/ROOT/pages/mapping_suite/index.adoc b/docs/antora/modules/ROOT/pages/mapping_suite/index.adoc
@@ -0,0 +1,23 @@
+= Getting started
+
+== Who are these docs written for
+
+== Glossary
+
+== Assumptions we make about the skills of the reader
+
+=== Prerequisites
+
+== what the user can achieve through these pages
+
+== Repository structure
+
+== Mapping suite anatomy
+
+== Code list mappings
+
+== Data samples
+
+== Versioning
+
+== References
diff --git a/...s/ROOT/pages/mapping-suite-structure.adoc → ...apping_suite/mapping-suite-structure.adoc b/...s/ROOT/pages/mapping-suite-structure.adoc → ...apping_suite/mapping-suite-structure.adoc
diff --git a/...dules/ROOT/pages/preparing-test-data.adoc → ...es/mapping_suite/preparing-test-data.adoc b/...dules/ROOT/pages/preparing-test-data.adoc → ...es/mapping_suite/preparing-test-data.adoc
diff --git a/...ules/ROOT/pages/repository-structure.adoc → ...s/mapping_suite/repository-structure.adoc b/...ules/ROOT/pages/repository-structure.adoc → ...s/mapping_suite/repository-structure.adoc
@@ -25,10 +25,10 @@ requirements.txt
 
 `/docs` folder contains this documentation. It is written in https://asciidoc.org/[AsciiDoc format] and compiled with https://antora.org/[Antora system].
 
-`/mappings` folder contains xref:mapping-suite-structure.adoc[mapping suite packages] organised based on the standard forms numbers. Their name is formed based on the form number (e.g. `F03`, `F06`) prefixed with `package_` for readability. When the eForms will be mapped, then the corresponding appropriate organisation will be chosen.
+`/mappings` folder contains xref:mapping_suite/mapping-suite-structure.adoc[mapping suite packages] organised based on the standard forms numbers. Their name is formed based on the form number (e.g. `F03`, `F06`) prefixed with `package_` for readability. When the eForms will be mapped, then the corresponding appropriate organisation will be chosen.
 
 `/src/mappings` folder represents the "single source of truth" for the mapping rules across various mapping suite packages. This is necessary because of the modularisation and reuse method adopted in this project. The basic idea is that the mapping rules are organised in modules and all are stored in the source folder. Each mapping suite provides in the conceptual mapping workbook the list of modules that be used to compose the complete set of transformation rules of the mapped form number.
 
-`/test_data` folder contains sample https://ted.europa.eu/TED/browse/browseByMap.do[TED notices] generated by different selection methods. Some manually selected notices are available in the `/sampling_manual` subfolder. The automatically generated notice samples that are in the `/sampling_2021` subfolder are described xref:preparing-test-data.adoc[here]. In the `sampling_2014_2022` subfolder there are samples, generated from all available notices in the 2014-2022 period that cover the various changes in the XML Schema over the years. More automatically generated samples will follow.
+`/test_data` folder contains sample https://ted.europa.eu/TED/browse/browseByMap.do[TED notices] generated by different selection methods. Some manually selected notices are available in the `/sampling_manual` subfolder. The automatically generated notice samples that are in the `/sampling_2021` subfolder are described xref:mapping_suite/preparing-test-data.adoc[here]. In the `sampling_2014_2022` subfolder there are samples, generated from all available notices in the 2014-2022 period that cover the various changes in the XML Schema over the years. More automatically generated samples will follow.
 
 
diff --git a/...ules/ROOT/pages/ted-sws-introduction.adoc → ...s/mapping_suite/ted-sws-introduction.adoc b/...ules/ROOT/pages/ted-sws-introduction.adoc → ...s/mapping_suite/ted-sws-introduction.adoc
diff --git a/...antora/modules/ROOT/pages/versioning.adoc → .../ROOT/pages/mapping_suite/versioning.adoc b/...antora/modules/ROOT/pages/versioning.adoc → .../ROOT/pages/mapping_suite/versioning.adoc
diff --git a/docs/antora/modules/ROOT/pages/sample_app/index.adoc b/docs/antora/modules/ROOT/pages/sample_app/index.adoc
diff --git a/docs/antora/modules/ROOT/pages/sample_app/jupyter_notebook.adoc b/docs/antora/modules/ROOT/pages/sample_app/jupyter_notebook.adoc
diff --git a/docs/antora/modules/ROOT/pages/sample_app/ms_excell.adoc b/docs/antora/modules/ROOT/pages/sample_app/ms_excell.adoc
diff --git a/docs/antora/modules/ROOT/pages/ted_data/jupyter_notebook.adoc b/docs/antora/modules/ROOT/pages/ted_data/jupyter_notebook.adoc
diff --git a/docs/antora/modules/ROOT/pages/ted_data/ms_excell.adoc b/docs/antora/modules/ROOT/pages/ted_data/ms_excell.adoc
diff --git a/docs/antora/modules/ROOT/partials/methodology/key-elements-for-mapping.adoc b/docs/antora/modules/ROOT/partials/methodology/key-elements-for-mapping.adoc
@@ -44,5 +44,6 @@ The output of the XML notice transformation will be an *RDF graph* instantiating
 
 The key element enabling transformation automation are the mapping files: *conceptual* and *technical* mappings. They are developed according to the <<_mapping_creation_method,mapping creation methodology>>.
 
-The mapping rules are organised in mapping suites, described xref:mapping-suite-structure.adoc[here].
+The mapping rules are organised in mapping suites, described xref:mapping_suite/mapping-suite-structure.adoc[here].
+
 
diff --git a/docs/antora/modules/ROOT/partials/methodology/mapping-creation-method.adoc b/docs/antora/modules/ROOT/partials/methodology/mapping-creation-method.adoc
@@ -140,7 +140,7 @@ This step is about making sure that all necessary sources are defined properly i
 
 ====  Prepare test data
 
-Please refer to the xref:preparing-test-data.adoc[representative sample data selection chapter].
+Please refer to the xref:mapping_suite/preparing-test-data.adoc[representative sample data selection chapter].
 
 ==== Write YARRRML Rules (optional)
 
@@ -287,3 +287,4 @@ While writing the mapping rules, make sure to document any issues that you are n
 
 Problems that were successfully resolved should be integrated in this guide, as recommendations, e.g. in one of the above sections, and marked as [SOLVED] in the document. Unless the problem turns out to be fairly trivial, or there is only one obvious solution to it. It would be recommended NOT to delete the issue from the “Problem description” document, so that we can keep track of the different issues, and the thinking that went into choosing certain solutions.
 
+