Merge pull request #153 from ESA-APEx/mtr_approved_updates

Synchronize updated content from MTR

Author: JanssenBrm

.markdownlint.yaml

@@ -7,3 +7,5 @@ line-length:
 
 MD024:
   siblings_only: true
+MD033:
+  no-inline-html: false

.markdownlintignore

@@ -2,3 +2,4 @@ interoperability/algohosting.md
 interoperability/algohostingenv.md
 interoperability/geospatial_explorer.qmd
 interoperability/businessmodel.md
+interoperability/datahosting.md

_quarto.yml

@@ -36,6 +36,8 @@ website:
         contents:
           - href: instantiation/usecases.qmd
             text: Use Cases
+          - href: instantiation/customisation.md
+          - href: instantiation/accessibility.md
           - href: instantiation/geospatial_explorer.md
           - href: instantiation/project_portal.md
           - href: instantiation/user_workspace.md
@@ -82,6 +84,7 @@ website:
           - href: interoperability/definitions.qmd
           - href: propagation/service_development.qmd
           - href: interoperability/algohosting.md
+          - href: interoperability/datahosting.md
           - href: interoperability/algohostingenv.md
           - href: interoperability/geospatial_explorer.qmd
           - href: interoperability/businessmodel.md

css/components/_tables.scss

@@ -25,3 +25,17 @@ th {
   background-color: var(--greylight) !important;
   color: var(--darkblue) !important;
 }
+
+
+table.requirements {
+  td, th {
+    padding: .5rem;
+    vertical-align: top;
+  }
+  td:first-child{
+    min-width: 150px;
+  }
+  td:nth-child(2){
+    width: 40%;
+  }
+}

guides/file_formats.qmd

@@ -2,7 +2,7 @@
 title: File format recommendations
 ---
 
-Within the APEx interoperability and compliance guidelines, [PROV-REQ-01](../interoperability/algohosting.md) specifies
+Within the APEx interoperability and compliance guidelines, [DATA-REQ-01](../interoperability/datahosting.md) specifies
 the file formats that projects should use when publishing static data.
 The information on this page complement that requirement with more detailed recommendations on the use of these formats.
 Projects are encouraged to consult with the APEx team if they have a use case that does not fit within these guidelines.
@@ -23,7 +23,7 @@ of GDAL to ensure that they are compliant:
 gdal_translate world.tif world_webmerc_cog.tif -of COG
 ```
 
-### Organizing spatiotemporal multi-band datasets
+### Organising spatiotemporal multi-band datasets
 
 Many datasets have multiple bands (or 'variables'), or have a date associated with them.
 The general recommendation is to store a single band per GeoTIFF file and to create STAC items with one asset per band.

guides/udp_writer_guide.quarto_ipynb

@@ -0,0 +1,21 @@
+---
+title: Accessing your environment
+---
+
+Each instantiated component is assigned a dedicated URL following the convention:
+
+`https://<tool>.<project>.apex.esa.int.`
+
+This URL assignment process is fully automated by APEx, including the generation of the necessary security certificates.
+For example, if a project named `project-a` requests the instantiation of a user forum and a project portal, the following
+URLs will be created:
+
+• `https://project-a.apex.esa.int` – the project portal
+• `https://forum.project-a.apex.esa.int` – the project's user forum
+
+This granular URL assignment ensures a clear separation between the different instantiated components, making them easy
+to manage and access. Additionally, as these URLs are publicly accessible, projects can seamlessly integrate the components
+into their existing websites by linking to them directly.
+
+In addition to the default URLs provided during component instantiation, APEx also supports the use of custom domains owned
+by the requesting project. Configuring custom domains requires additional setup, which is handled upon request.

instantiation/accessibility.md

@@ -8,6 +8,8 @@ The Product Catalogue enables projects to create their own SpatioTemporal Asset
 comprehensive metadata collection for efficient organisation and discovery of geospatial data assets. This information
 is presented in a user-friendly JSON format.
 
+![APEx Product Catalogue](images/stac_browser_1.jpg)
+
 Instantiating a project-specific catalogue gives projects the freedom to use it for a range of purposes, from
 experimental to operational use cases. Assets that are considered project deliverables will normally be added to the
 centralised project results repository.

instantiation/catalog.qmd

@@ -0,0 +1,17 @@
+---
+title: Customisation
+---
+
+The APEx Project Environments are designed to adapt to the unique needs of each project. Except for the User Workspace and
+IDE service, which are offered as a combined package, all other services can be requested and instantiated independently.
+This modular approach allows projects to select only the tools that align with their specific requirements. Each service
+is accessible via a public URL, enabling seamless integration into existing project components.
+
+In addition to the flexibility of service selection, each service can be customised to reflect the project's branding and
+aesthetics. The degree of customisation depends on the capabilities of the underlying software, typically focusing on general
+visual elements such as logos and colour schemes.
+
+Currently, customisation is performed during the instantiation process in close collaboration with the project team. As the
+APEx project evolves, additional mechanisms to streamline and enhance service customisation will be explored. For projects
+requiring more detailed adjustments, APEx will provide access to the software’s technical documentation, empowering teams
+to further tailor the services to their needs.

instantiation/customisation.md

@@ -13,6 +13,8 @@ writing with scientific plotting and code snippets. It also allows for introduci
 documentation. Projects that do not feel comfortable with an approach based on Markdown for editing and Git for
 versioning are still free to use those traditional formats.
 
+![APEx Documentation Portal](images/documentation.png)
+
 Quarto generates fully customisable online documentation portals tailored for scientific publications, featuring
 interactive visualisations. It supports various scientific elements, including formulas, diagrams, and code.
 Additionally, Quarto can produce PDF or Word documents, making it ideal for scenarios where user documentation needs to