diff --git a/guides/project_portal/index.qmd b/guides/project_portal/index.qmd index 2bb6b56..04b1f4d 100644 --- a/guides/project_portal/index.qmd +++ b/guides/project_portal/index.qmd @@ -1,5 +1,5 @@ --- -title: Project Portal +title: Project Web Portal listing: contents: "tutorials" type: "grid" @@ -7,17 +7,17 @@ listing: filter-ui: true --- -Welcome to the user guide for the [APEx Project Portal](../../instantiation/project_portal.md), a powerful tool designed +Welcome to the user guide for the [APEx Project Web Portal](../../instantiation/project_portal.md), a powerful tool designed to support your project communication. In this user guide, you will find essential information and resources tailored to help you navigate the portal efficiently. For a more general overview, we encourage you to explore the documentation available for the -[APEx Project Portal](../../instantiation/project_portal.md) and its [use cases](../../instantiation/usecases.qmd), where +[APEx Project Web Portal](../../instantiation/project_portal.md) and its [use cases](../../instantiation/usecases.qmd), where you will discover how you can effectively use it within your project. This user manual is designed for web managers and editors responsible for setting up, editing, and maintaining their project website. It provides you with a list of tutorials that focus on the most common tasks you may encounter while using the APEx -Project Portal. Whether you are a newcomer or an experienced user, these tutorials will empower you to utilize the tool to +Project Web Portal. Whether you are a newcomer or an experienced user, these tutorials will empower you to utilize the tool to its fullest potential. Furthermore, as the portal is built on the [Drupal](https://new.drupal.org/home) framework, we recommend checking the diff --git a/guides/project_portal/tutorials/1_login.qmd b/guides/project_portal/tutorials/1_login.qmd index c83be3f..dcbde8e 100644 --- a/guides/project_portal/tutorials/1_login.qmd +++ b/guides/project_portal/tutorials/1_login.qmd @@ -1,5 +1,5 @@ --- -title: "Login to the Project Portal and the Drupal content overview" +title: "Login to the Project Web Portal and the Drupal content overview" image: ../images/cover_login.png lightbox: true --- @@ -32,7 +32,7 @@ can manage: ::: ::: {.g-col-4} -![Project Portal login screen](../images/login_1.png){group="gallery-login"} +![Project Web Portal login screen](../images/login_1.png){group="gallery-login"} ![APEx login screen](../images/login_2.jpg){group="gallery-login"} diff --git a/guides/project_portal/tutorials/3c_news.qmd b/guides/project_portal/tutorials/3c_news.qmd index 6ad8e06..b7ff054 100644 --- a/guides/project_portal/tutorials/3c_news.qmd +++ b/guides/project_portal/tutorials/3c_news.qmd @@ -4,7 +4,7 @@ image: ../images/cover_news.png lightbox: true --- -The project portal allows you to add news items and an overview of all news items. The overview can be implemented via a +The Project Web Portal allows you to add news items and an overview of all news items. The overview can be implemented via a separate web page or you can also add a **news** paragraph on any web page to list the latest news items for example. ## Add a news item diff --git a/guides/project_portal/tutorials/4_menu.qmd b/guides/project_portal/tutorials/4_menu.qmd index 626dd7f..53cb10d 100644 --- a/guides/project_portal/tutorials/4_menu.qmd +++ b/guides/project_portal/tutorials/4_menu.qmd @@ -34,7 +34,7 @@ Via the main navigation overview, which you can access when you navigate to **st administration toolbar, you can easily disable or enable main navigation (sub)menu items. Select the **Enabled** check to show the menu item in the main navigation or deselect the **Enabled** checkbox to hide the menu item in the main navigation. -## Edit the name of your project portal +## Edit the name of your Project Web Portal Upon instantiation of your project web portal, the name of your project will be set to display in the top left corner in the header section, left from the main menu navigation, and in the footer. The acronym and/or full name will use the primary diff --git a/instantiation/accessibility.md b/instantiation/accessibility.md index 5ecb8a7..5c7309e 100644 --- a/instantiation/accessibility.md +++ b/instantiation/accessibility.md @@ -4,14 +4,18 @@ title: Accessing your environment Each instantiated component is assigned a dedicated URL following the convention: -`https://..apex.esa.int.` +`https://..apex.esa.int` + +The only exception to this rule is the project web portal, which is hosted at: + +`https://.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 +For example, if a project named `project-a` requests the instantiation of a user forum and a project web 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 +* `https://project-a.apex.esa.int` – the project web 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 diff --git a/instantiation/app_code_server.md b/instantiation/app_code_server.md index c13dd0f..b723385 100644 --- a/instantiation/app_code_server.md +++ b/instantiation/app_code_server.md @@ -2,9 +2,7 @@ title: Code Server IDE --- -Code Server Interactive Development Environment - Tailored User Workspace - -## Code Server overview +## Overview The Code Server Interactive Development Environment (IDE) capacity within the APEx Project Environments primarily leverages the power of the [Code Server software (Visual Studio Code in the Cloud)](#code-server-software-architecture). @@ -21,7 +19,7 @@ them to harness the computational power of remote servers. Tailored specifically for EO tasks, this environment furnishes developers with an array of tools and libraries fine-tuned for programming languages and productivity plugins or extensions. -## Code Server software architecture +## Software Architecture The APEx Code Server solution is an Integrated Development Environment delivered as a cloud-based user workspace, tailored to support the activities of Earth observation (EO) projects. @@ -54,7 +52,7 @@ their local machine's hardware capabilities, enabling them to leverage the compu Code Server serves as the core development environment, providing a powerful and flexible platform for coding and debugging, allowing developers to harness server-side computational power while maintaining a familiar interface. -### Code Server key features +### Key Features The APEx Code Server IDE includes several features that make it suitable for both individual researchers and teams working on EO research and applications. @@ -74,7 +72,7 @@ complemented by a vast repository of extensions for virtually any language or fi Leverage integrated Git support, allowing team members to work on the same project by tracking changes and merging updates, helping to keep the code organised while avoiding conflicting code changes. -## Code Server showcase scenarios +## Showcase Scenarios The APEx Code Server IDE supports a variety of use cases, making it an essential tool for developers, researchers, and data scientists within the EO community. Some typical scenarios include: @@ -82,7 +80,7 @@ researchers, and data scientists within the EO community. Some typical scenarios * **Algorithm Development and Testing**\ Researchers and developers can write, test, and debug new algorithms for processing satellite imagery or other EO data. For instance, a user might develop a script to detect deforestation using -multi-temporal satellite images. To support the productivity of developers, the Code Server solution uses +multi-temporal satellite images. To support the productivity of developers, the Code Server solution uses a mechanism of extensions. Code Server extensions are available from the Open VSX Registry. ::: {.callout-note} @@ -98,7 +96,7 @@ leave the Code Server user interface * [Edit](https://continue.dev/docs/edit/how-to-use-it) is a convenient way to modify code without leaving your current file * [Actions](https://continue.dev/docs/actions/how-to-use-it) are shortcuts for common use cases. -This extension asks for API keys to use the models. +This extension asks for API keys to use the models. This has been successfully tested and could be an option for the APEx use cases. ::: diff --git a/instantiation/app_jupyterlab.md b/instantiation/app_jupyterlab.md index 72afe8b..a536be3 100644 --- a/instantiation/app_jupyterlab.md +++ b/instantiation/app_jupyterlab.md @@ -2,9 +2,7 @@ title: JupyterLab IDE --- -JupyterLab Interactive Development Environment - Tailored User Workspace - -## JupyterLab overview +## Overview The JupyterLab Interactive Development Environment (IDE) capacity within the APEx Project Environments primarily leverages the power of the [JupyterLab](#jupyterlab-software-architecture) software. @@ -21,12 +19,12 @@ them to harness the computational power of remote servers. Tailored specifically for EO tasks, this environment furnishes developers with an array of tools and libraries fine-tuned for programming languages and productivity plugins or extensions. -## JupyterLab software architecture +## Software Architecture The JupyterLab setup encapsulates a web-based interactive development environment for Jupyter notebooks, code, and data. It is the user interface for Project Jupyter, offering a flexible user interface and more features than the classic notebook UI. It is a web application providing a development environment in which processing algorithms and services can be developed, -tested, and debugged. +tested, and debugged. ![The JupyterLab IDE in the current APEx workspaces offering ](images/applicationhub_jupyterlab.png) @@ -35,7 +33,7 @@ Julia, R, Haskell, Ruby, and Python (via the IPython kernel). It seamlessly adap developers to create, test, and deploy applications within isolated, replicable, and consistent environments, ensuring consistent behaviour across development, staging, and production phases. -### JupyterLab key features +## Key Features The APEx JupyterLab IDE includes several features that make it suitable for both individual researchers and teams working on EO research and applications. @@ -53,7 +51,7 @@ various levels of support. Leverage integrated Git support, allowing team members to work on the same project by tracking changes and merging updates, helping to keep the code organized while avoiding conflicting code changes. -## JupyterLab showcase scenarios +## Showcase Scenarios The APEx JupyterLab IDE supports a variety of use cases, making it an essential tool for developers, researchers, and data scientists within the EO community. Some typical scenarios include: @@ -61,10 +59,10 @@ researchers, and data scientists within the EO community. Some typical scenarios * **Algorithm Development and Testing**\ Researchers and developers can write, test, and debug new algorithms for processing satellite imagery or other EO data. For instance, a user might develop a script to detect deforestation using -multi-temporal satellite images. To support the productivity of developers, both the JupyterLab solution use a mechanism of extensions. +multi-temporal satellite images. To support the productivity of developers, both the JupyterLab solution use a mechanism of extensions. ::: {.callout-note} -There is no GitHub Copilot extension available yet for JupyterLab. +There is no GitHub Copilot extension available yet for JupyterLab. See the [Code Server IDE](./app_code_server.md) page for more details on CoPilot extensions. @@ -86,7 +84,7 @@ working with notebooks, with its native support for data science, data visualisa ## Examples -@tbl-ide-examples showcases example projects that utilize the APEx JupyterLab IDE. +@tbl-ide-examples showcases example projects that utilize the APEx JupyterLab IDE. It is important to note that a valid APEx account and permissions from the project are required to access an environment. diff --git a/instantiation/app_qgis.md b/instantiation/app_qgis.md index a911c7b..16a7765 100644 --- a/instantiation/app_qgis.md +++ b/instantiation/app_qgis.md @@ -2,8 +2,6 @@ title: QGIS as a Remote Desktop --- -QGIS as a Remote Desktop - Tailored User Workspace - ## Overview The Geographic Information System capacity within the APEx Project Environments primarily leverages the power @@ -18,8 +16,7 @@ tasks or needing access to a consistent development environment from various loc The server-based nature ensures that users are not constrained by their local machine's hardware capabilities, allowing them to harness the computational power of remote servers. - -## QGIS software architecture +## Software Architecture The APEx QGIS workspace is a fully-fledged Geographic Information System delivered as a cloud-based user workspace, tailored to support the activities of Earth observation (EO) projects. @@ -27,7 +24,7 @@ to support the activities of Earth observation (EO) projects. ![QGIS on a Remote Desktop in the current APEx workspaces offering ](images/applicationhub_qgis.png) Each QGIS workspace comes equipped with the free and open source software project hosted on QGIS.org association, as well -as with a private data products catalogue. These features empower developer users to edit and build EO-based mapping products +as with a private data products catalogue. These features empower developer users to edit and build EO-based mapping products and geospatial workflows, accelerating project outcomes within a dedicated, tool-rich environment. ### Key Features @@ -53,7 +50,6 @@ Store, manage, and share QGIS projects with the ability to connect to external d Teams can work collaboratively on GIS projects, sharing data and resources in real-time. A group of data scientists might collaboratively develop crop yields scenario maps based on various data inputs. - ## Examples Several examples are under development and will be added on this page. diff --git a/instantiation/catalog.qmd b/instantiation/catalog.qmd index 2595bad..8080176 100644 --- a/instantiation/catalog.qmd +++ b/instantiation/catalog.qmd @@ -8,7 +8,7 @@ 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) +![APEx Product Catalogue](images/stac_browser_1.png) 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 @@ -48,15 +48,15 @@ The product catalogue serves several beneficial scenarios for projects: ### STAC Catalogue API -You will get a dedicated STAC catalog, hosted and managed by APEx. This gives you full control over the metadata, +You will get a dedicated STAC catalogue, hosted and managed by APEx. This gives you full control over the metadata, without having to worry about IT aspects such as security, backup or monitoring the service. The catalogue supports creating both private and public collections. #### Key Considerations -* **Data storage**: The STAC catalogue does _not_ include data storage. It is recommended to request object storage access +* **Data storage**: The STAC catalogue does include limited data storage. It is recommended to request object storage access from one of the cloud providers in the Network of Resources (NoR). -* M**etadata Creation**: The process of creating metadata is not automated. You will need to provide the metadata in +* **Metadata Creation**: The process of creating metadata is not automated. You will need to provide the metadata in JSON format, giving you complete flexibility in choosing the STAC extensions that best suit your requirements. @@ -72,12 +72,12 @@ is not provided. ### STAC Browser In addition to the STAC Catalogue API, APEx provides a dedicated STAC Browser to support the visual exploration of your -catalog's content. This browser is seamlessly integrated with the instantiated API and is automatically configured upon +catalogue's content. This browser is seamlessly integrated with the instantiated API and is automatically configured upon initialization to display the results published in your STAC API. -![STAC Browser - Collections](images/stac_browser_1.jpg) +![STAC Browser - Collections](images/stac_browser_1.png) -![STAC Browser - Collection Details](images/stac_browser_2.jpg) +![STAC Browser - Collection Details](images/stac_browser_2.png) #### Underlying Technology diff --git a/instantiation/documentation.qmd b/instantiation/documentation.qmd index 4e8372a..b597373 100644 --- a/instantiation/documentation.qmd +++ b/instantiation/documentation.qmd @@ -55,8 +55,8 @@ A documentation portal can support several project scenarios, including: The APEx Documentation Portal Service provides users with a streamlined template to initiate their documentation process. As changes are made, advanced automation tools ensure that the documentation is published seamlessly to a location that -integrates effortlessly within your project portal. This service is most effective when used in conjunction with the -[APEx Project Portal](./project_portal.md), maximizing the level of integration. +integrates effortlessly within your project web portal. This service is most effective when used in conjunction with the +[APEx Project Web Portal](./project_portal.md), maximizing the level of integration. This documentation template includes the following features: diff --git a/instantiation/images/stac_browser_1.jpg b/instantiation/images/stac_browser_1.jpg deleted file mode 100644 index 00812ef..0000000 Binary files a/instantiation/images/stac_browser_1.jpg and /dev/null differ diff --git a/instantiation/images/stac_browser_1.png b/instantiation/images/stac_browser_1.png new file mode 100644 index 0000000..b5b0b54 Binary files /dev/null and b/instantiation/images/stac_browser_1.png differ diff --git a/instantiation/images/stac_browser_2.jpg b/instantiation/images/stac_browser_2.jpg deleted file mode 100644 index 963c35c..0000000 Binary files a/instantiation/images/stac_browser_2.jpg and /dev/null differ diff --git a/instantiation/images/stac_browser_2.png b/instantiation/images/stac_browser_2.png new file mode 100644 index 0000000..6d77965 Binary files /dev/null and b/instantiation/images/stac_browser_2.png differ diff --git a/instantiation/index.md b/instantiation/index.md index b5954e9..da08a62 100644 --- a/instantiation/index.md +++ b/instantiation/index.md @@ -3,25 +3,27 @@ title: Dynamic software components for your project --- The APEx Project Environments are designed to provide managed, configurable environments that support the collaboration, -development, exploration, and visualisation of Earth Observation (EO) application project results. -These tools are crucial for facilitating the effective sharing, maintenance, and utilisation of project outcomes within +development, exploration, and visualisation of Earth Observation (EO) application project results. +These tools are crucial for facilitating the effective sharing, maintenance, and utilisation of project outcomes within the Earth Observation community, ensuring that they remain readily accessible and usable for extended time periods. -APEx aims to cater to the diverse and multifaceted needs of the EO community by delivering Project Environments as Software as a Service (SaaS) -products. It manages the delivery of either single-user or shared environments, managed within a unified cloud infrastructure, -thus facilitating a wide range of user tasks, including development, hosting, execution, and exploratory analysis of EO applications. +APEx aims to cater to the diverse and multifaceted needs of the EO community by delivering Project Environments as Software +as a Service (SaaS) products. It manages the delivery of either single-user or shared environments, managed within a +unified cloud infrastructure, thus facilitating a wide range of user tasks, including development, hosting, execution, +and exploratory analysis of EO applications. -At the core of the APEx Project Environments is the ability for APEx to manage and deliver these environments effectively. -Project-wide community-oriented tools, such as the Project Web Portal, Products Catalogue, Documentation Hub, and User Forum, -are managed directly by Kubernetes and typically instantiated once per project. -Conversely, single-user-specific workspaces allow the instantiation of Apps by a single user at any time, while sharing data across these Apps. -These tools, including the User Workspace Finder, the Code Server Interactive Development Environment (IDE), -the JupyterLab workspace, the QGIS user workspace, and in certain cases, dashboards and web applications, -are all managed by a dedicated ApplicationHub server. This ApplicationHub orchestrates the launch and management of such software deployments, -ensuring secured (isolated from other users) and customisable environments for individual users, while allowing targetted file sharing operations among users. +At the core of the APEx Project Environments is the ability for APEx to manage and deliver these environments effectively. +Project-wide community-oriented tools, such as the Project Web Portal, Product Catalogue, Documentation Portal, and User +Forum, are managed directly by Kubernetes and typically instantiated once per project. +Conversely, single-user-specific workspaces allow the instantiation of Apps by a single user at any time, while sharing +data across these Apps. These tools, including the User Workspace Finder, the Code Server Interactive Development +Environment (IDE),the JupyterLab workspace, the QGIS user workspace, and in certain cases, dashboards and web applications, +are all managed by a dedicated ApplicationHub server. This ApplicationHub orchestrates the launch and management of such +software deployments,ensuring secured (isolated from other users) and customisable environments for individual users, while +allowing targeted file sharing operations among users. -A key feature of the APEx Project Environments is the ability to provide managed, configurable environments. -These environments can be tailored to the specific needs of different projects and users, supporting various tasks, +A key feature of the APEx Project Environments is the ability to provide managed, configurable environments. +These environments can be tailored to the specific needs of different projects and users, supporting various tasks, including exploratory analysis, development, hosting, and execution of EO applications. This flexibility and configurability allow the project members to focus on their primary research objectives without being bogged down by the technical complexities of setting up and maintaining advanced, Cloud-native workspaces. @@ -40,15 +42,15 @@ The specific components of the APEx Project Environments include: web services based on a configuration defined by a dashboard administrator. * **[Project Web Portal](project_portal.md)**\ Creating a project website based on Drupal, working in synergy with other APEx services. -// * [**User Workspace Finder**](user_workspace_finder.md)\ -// Offering a secure and personalised work environment with data management and data sharing mechanisms. + * [**Code Server IDE**](app_code_server.md)\ Leveraging IDE capabilities tailored specifically for EO tasks, based on the open-source software Code Server (VS Code in the browser). * [**JupyterLab IDE**](app_jupyterlab.md)\ Leveraging IDE capabilities tailored specifically for EO tasks, based on open-source software JupyterLab. * [**QGIS on a Remote Desktop**](app_qgis.md)\ Leveraging Geographic Information System functions, based on the open-source software QGIS. -* [**Products Catalogue**](catalog.qmd)\ +* [**Product Catalogue**](catalog.qmd)\ Featuring SpatioTemporal Asset Catalog (STAC) catalogues and streamlined data ingestion processes. * [**Documentation Portal**](documentation.qmd)\ Supporting customisation and interactive visualisation using the Quarto framework. @@ -71,7 +73,7 @@ Projects can interconnect their instantiated services in several ways: * **Integrated Navigation**: If a project already has a public-facing website or uses the APEx [Project Web Portal](./project_portal.md), links to the instantiated tools, such as the -[Geospatial Explorer](./geospatial_explorer.md), [Products Catalogue](./catalog.qmd) or [JupyterLab](./app_jupyterlab.md), can be +[Geospatial Explorer](./geospatial_explorer.md), [Product Catalogue](./catalog.qmd) or [JupyterLab](./app_jupyterlab.md), can be embedded directly into the site's navigation structure. This provides a unified access point for project stakeholders and visitors to the project website. diff --git a/instantiation/project_portal.md b/instantiation/project_portal.md index 9ff0466..57847cf 100644 --- a/instantiation/project_portal.md +++ b/instantiation/project_portal.md @@ -1,24 +1,24 @@ --- -title: Project Portal +title: Project Web Portal --- ## Overview -The Project Portal will provide a solution designed to support the needs of projects by providing a project website upon +The Project Web Portal will provide a solution designed to support the needs of projects by providing a project website upon request. The portal, structured on a predefined base template, will offer the flexibility to further customise the overall user experience. Beyond the initial theming options, the service incorporates a Drupal Content Management System (CMS), empowering project members to perform advanced customisations and efficiently manage portal content. -![APEx Project Portal](images/portal.png) +![APEx Project Web Portal](images/portal.png) -The instantiated project portal will have the option to work in synergy with other services offered within APEx. This +The instantiated project web portal will have the option to work in synergy with other services offered within APEx. This collaborative approach enables projects to extend their portal by instantiating other APEx services, such as a [STACcatalogue](catalog.qmd), a [Geospatial Explorer](geospatial_explorer.md), a [User Forum](forum.md), and more, and -linking them to the main project portal, resulting in a dedicated, streamlined project ecosystem. +linking them to the main project web portal, resulting in a dedicated, streamlined project ecosystem. ## Showcase Scenarios -The project portal can bring a lot of value to projects, including: +The project web portal can bring a lot of value to projects, including: * **Efficient project dissemination and community engagement**\ Facilitates the rapid and broad dissemination of project information, ensuring that updates, results, and important @@ -44,11 +44,11 @@ support, such as changing the color scheme and project logo. Upon creation of yo account will be created, allowing you to invite other project members. Using the built-in content management system, your project is free to manage the content of the full website. -In addition to providing your project portal, APEx ensures optimal performance and availability through continuous +In addition to providing your project web portal, APEx ensures optimal performance and availability through continuous monitoring. Automated maintenance tasks, such as updates and backups, are conducted to minimize downtime and maintain data integrity. This approach establishes a robust and dependable environment for users. -By April 2026, the APEx Project Portal service will be integrated into the ESA Network of Resources (NoR). Until these +By April 2026, the APEx Project Web Portal service will be integrated into the ESA Network of Resources (NoR). Until these services are onboarded, projects can reach out to the APEx team to explore how we can support their hosting needs. APEx also manages DNS setup, ensuring your project’s website is accessible on the internet without any additional technical burden. @@ -58,13 +58,13 @@ technical aspects, making it a valuable and efficient solution for project disse ## What software is used by APEx? -For the project portal service, APEx uses the [Drupal](https://www.drupal.org/) framework. Drupal is an open-source +For the project web portal service, APEx uses the [Drupal](https://www.drupal.org/) framework. Drupal is an open-source platform for creating and managing web content. In addition to its extensive content management features, it also allows for detailed customization. ## Examples -@tbl-portal-examples showcases example projects that use the APEx Project Portal: +@tbl-portal-examples showcases example projects that use the APEx Project Web Portal: | Project | URL | | :------------------------------ | :------------------------------------------------------- | @@ -72,12 +72,12 @@ for detailed customization. | APEx (Demo) | [https://demo.apex.esa.int/](https://demo.apex.esa.int/) | | World Ecosystem Extent Dynamics | [https://esa-worldecosystems.org/](https://esa-worldecosystems.org/) | -: APEx Project Portal - Project Examples {#tbl-portal-examples}{tbl-colwidths="[30,70]"} +: APEx Project Web Portal - Project Examples {#tbl-portal-examples}{tbl-colwidths="[30,70]"} ## User Documentation -For a step-by-step guide on how to use and manage your project portal, refer to the official -[Project Portal User Guide](../guides/project_portal/) +For a step-by-step guide on how to use and manage your project web portal, refer to the official +[Project Web Portal User Guide](../guides/project_portal/) :::{.callout-tip} diff --git a/instantiation/usecases.qmd b/instantiation/usecases.qmd index 32afba6..d73ff81 100644 --- a/instantiation/usecases.qmd +++ b/instantiation/usecases.qmd @@ -19,9 +19,9 @@ streamlined through secure, scalable environments, ensuring that users can handl It is important to highlight that the APEx Project Environments can be combined in different ways to create a flexible collaborative project environment. This gives projects the flexibility to adapt the tools based on their needs. For -example, they can choose to make the project portal as their main entry point for both project members and their +example, they can choose to make the project web portal as their main entry point for both project members and their community, linking to the different APEx tools from within the main website. Alternatively, projects can decide to only -keep the project portal for public communication and dissemination, while having the user workspaces only visible for +keep the project web portal for public communication and dissemination, while having the user workspaces only visible for the project members. In essence, the APEx Project Environments provide an a la carte approach for setting up and configuring your project environment based on your needs. @@ -38,7 +38,7 @@ including stakeholders, policymakers, and the general public. ### Key Components -* [**Project Portal**](project_portal.md)\ +* [**Project Web Portal**](project_portal.md)\ Provides dynamic instantiation using Drupal, allowing project managers to create and maintain a visually appealing and informative site. * [**Geospatial Explorer**](geospatial_explorer.md)\ @@ -53,7 +53,8 @@ including stakeholders, policymakers, and the general public. %%| fig-cap: "APEx Project Environments - Project Promotion" flowchart TD "" subgraph Public Environment - A(Project Portal) -->|Links to| B(Geospatial
Explorer) + direction TB + A(Project Web Portal) -->|Links to| B(Geospatial
Explorer) A -->|Links to| C(Documentation
Portal) A -->|Links to| D(User
Forum) end @@ -81,7 +82,7 @@ help, share knowledge, and collaborate on EO applications. ### Key Components -* [**Project Portal**](project_portal.md)\ +* [**Project Web Portal**](project_portal.md)\ Provides dynamic instantiation using Drupal, allowing project managers to create and maintain a visually appealing and informative site. * [**User Forum**](forum.md)\ @@ -100,10 +101,12 @@ help, share knowledge, and collaborate on EO applications. %%| fig-cap: "APEx Project Environments - User Support" flowchart TD "" subgraph Project Environment + direction TB UW(User Workspace) --> |Activate| IDE(Interactive Development
Environment) end subgraph Public Environment - A(Project Portal) -->|Links to| C(Documentation
Portal) + direction TB + A(Project Web Portal) -->|Links to| C(Documentation
Portal) A -->|Links to| D(User
Forum) end @@ -132,8 +135,8 @@ project-specific visualisations, helping users to interpret and communicate data * [**Geospatial Explorer**](geospatial_explorer.md)\ Functional enhancements to provide interactive and real-time data visualisations, supporting both raster and tabular data visualisations. -* [**Project Portal**](project_portal.md)\ - Integration of visualisations into project portals to showcase data insights. +* [**Project Web Portal**](project_portal.md)\ + Integration of visualisations into project web portals to showcase data insights. * [**Documentation Portal**](documentation.qmd)\ Interactive visualisations within documentation to explain data findings and methodologies. @@ -142,7 +145,8 @@ project-specific visualisations, helping users to interpret and communicate data %%| fig-cap: "APEx Project Environments - Data Visualization" flowchart TD "" subgraph Public Environment - A(Project Portal) -->|Links to| B(Geospatial
Explorer) + direction TB + A(Project Web Portal) -->|Links to| B(Geospatial
Explorer) A -->|Links to| C(Documentation
Portal) end @@ -172,8 +176,8 @@ providing powerful tools and environments for data processing and statistical an [Code Server](./app_code_server.md) or [JupyterLab](./app_jupyterlab.md). * **User Workspace**\ Secure and scalable environments for conducting extensive data analysis. -* [**Project Portal**](project_portal.md)\ - Integration of visualisations into project portals to showcase data insights. +* [**Project Web Portal**](project_portal.md)\ + Integration of visualisations into project web portals to showcase data insights. * [**Product Catalogue**](catalog.qmd)\ A STAC catalogue providing easy access to EO datasets and streamlining the data ingestion process. * [**Geospatial Explorer**](geospatial_explorer.md)\ @@ -184,10 +188,12 @@ providing powerful tools and environments for data processing and statistical an %%| fig-cap: "APEx Project Environments - Data Analytics" flowchart TD "" subgraph Project Environment + direction TB UW(User Workspace) --> |Activate| IDE(Interactive Development
Environment) end subgraph Public Environment - A(Project Portal) -->|Links to| B(Geospatial
Explorer) + direction TB + A(Project Web Portal) -->|Links to| B(Geospatial
Explorer) B -->|Visualizes| C(Product
Catalogue) A -->|Links to| C end @@ -220,10 +226,10 @@ effectively. * **User Workspace**\ Providing secure environments for executing data processing tasks on existing cloud-based processing platforms. * **Interactive Development Environment (IDE)**\ -Leveraging the capabilities of [Code Server](./app_code_server.md) or [JupyterLab](./app_jupyterlab.md) IDS to support +Leveraging the capabilities of [Code Server](./app_code_server.md) or [JupyterLab](./app_jupyterlab.md) IDEs to support data processing scripts and workflows, including pre-configured tools for EO tasks. -* [**Project Portal**](project_portal.md)\ - Integration of visualisations into project portals to showcase data insights. +* [**Project Web Portal**](project_portal.md)\ + Integration of visualisations into project web portals to showcase data insights. * [**Product Catalogue**](catalog.qmd)\ Streamlined data ingestion and access to a wide range of EO datasets. * **[Geospatial Explorer](geospatial_explorer.md) and Web Apps**\ @@ -234,10 +240,12 @@ Interactively visualise results. %%| fig-cap: "APEx Project Environments - Data Processing" flowchart TD "" subgraph Project Environment + direction TB UW(User Workspace) --> |Activate| IDE(Interactive Development
Environment) end subgraph Public Environment - A(Project Portal) -->|Links to| B(Geospatial
Explorer) + direction TB + A(Project Web Portal) -->|Links to| B(Geospatial
Explorer) B -->|Visualizes| C(Product
Catalogue) A -->|Links to| C end diff --git a/interoperability/datahosting.md b/interoperability/datahosting.md index 00deef9..5e82624 100644 --- a/interoperability/datahosting.md +++ b/interoperability/datahosting.md @@ -51,3 +51,8 @@ fostering wider adoption and enabling advanced use cases in downstream applicati Table: Interoperability requirements for data providers ::: + +:::{.callout-tip title="File Format Recommendations"} +For more details regarding the recommended file formats and their usage within APEx, please refer to the +[APEx File Format Recommendations](../guides/file_formats.qmd). +::: diff --git a/propagation/onboarding.md b/propagation/onboarding.md index ed919ab..b6aca96 100644 --- a/propagation/onboarding.md +++ b/propagation/onboarding.md @@ -125,13 +125,13 @@ steps to get started: 1. **Host Your Algorithm**: Ensure your algorithm is hosted on an [APEx-compliant platform](./platforms.md). If you need assistance in selecting a suitable platform, refer to the [Hosting Platform Onboarding Support](#hosting-platform-onboarding-support) section. -2. **Prepare Your Algorithm Record**: Create a detailed record of your algorithm, including its functionalities, input/output -specifications, and any relevant metadata. This record should adhere to the guidelines provided in the +2. **Prepare Your Algorithm Record**: Create a detailed record of your algorithm service, including its functionalities, +input/output specifications, and any relevant metadata. This record should adhere to the guidelines provided in the [APEx Algorithm Services Catalogue](https://esa-apex.github.io/apex_algorithms/catalogue.html). -3. **Submit a Pull Request**: To officially onboard your algorithm, submit a pull request (PR) to the +3. **Submit a Pull Request**: To officially onboard your algorithm service, submit a pull request (PR) to the [APEx Algorithms GitHub Repository](https://github.com/ESA-APEx/apex_algorithms). -4. **Review and Approval**: The APEx team will review your submission. If everything is in order, your algorithm will be -approved and added to the catalogue. -5. **Catalogue Integration**: Once approved, your algorithm will be listed in the +4. **Review and Approval**: The APEx team will review your submission. If everything is in order, your algorithm service +will be approved and added to the catalogue. +5. **Catalogue Integration**: Once approved, your algorithm service will be listed in the [APEx Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/), making it accessible to the EO community. diff --git a/propagation/platforms.md b/propagation/platforms.md index 13eb97b..3dbd741 100644 --- a/propagation/platforms.md +++ b/propagation/platforms.md @@ -3,7 +3,7 @@ title: Supported Platforms --- This section provides an overview of APEx-compliant algorithm hosting environments based on the -[APEx interoperability and compliance guidelines](../interoperability/algohostingenv.md). The list includes platforms +[APEx Interoperability and Compliance Guidelines](../interoperability/algohostingenv.md). The list includes platforms available for each APEx-compliant technology, along with recommendations for environments that support the development process of APEx-compliant services. @@ -13,7 +13,7 @@ their preferred platform. ## openEO User Defined Processes An openEO UDP can be developed in any openEO-based environment using existing [openEO tools](https://openeo.org/documentation/1.0/). -APEx can support development activities by providing projects with access to its [Code Server and JupyterLab IDE solutions](../instantiation/index.md). +APEx can support development activities by providing projects with access to its [Code Server and JupyterLab IDE solutions](../instantiation/index.md). For testing the UDP, we recommend utilising an APEx-compliant hosting platform. This ensures platform compatibility and facilitates the deployment of your UDP as an on-demand service. Currently, APEx as identified the following platforms as compliant with the APEx guidelines: @@ -23,11 +23,11 @@ as identified the following platforms as compliant with the APEx guidelines: ## OGC Earth Observation Application Package (EOAP) processes -To develop and test an OGC Earth Observation Application Package, you can use one of the following environments, +To develop and test an OGC Earth Observation Application Package, you can use one of the following environments, which include the necessary tools and basic infrastructure to support the development process: * [ELLIP Studio](https://ellip.terradue.com/) -* [APEx Code Server IDE](../instantiation/app_code_server.md) +* [APEx Code Server IDE](../instantiation/app_code_server.md) * [APEx JupyterLab IDE](../instantiation/app_jupyterlab.md) ### OGC API - Processes