Skip to content

Commit c4fa96a

Browse files
authored
Merge pull request #166 from ESA-APEx/fixes_sor2
Fixes sor2
2 parents 19a9a42 + bed2674 commit c4fa96a

File tree

20 files changed

+114
-103
lines changed

20 files changed

+114
-103
lines changed

guides/project_portal/index.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
2-
title: Project Portal
2+
title: Project Web Portal
33
listing:
44
contents: "tutorials"
55
type: "grid"
66
sort: 'filename'
77
filter-ui: true
88
---
99

10-
Welcome to the user guide for the [APEx Project Portal](../../instantiation/project_portal.md), a powerful tool designed
10+
Welcome to the user guide for the [APEx Project Web Portal](../../instantiation/project_portal.md), a powerful tool designed
1111
to support your project communication.
1212

1313
In this user guide, you will find essential information and resources tailored to help you navigate the portal efficiently.
1414
For a more general overview, we encourage you to explore the documentation available for the
15-
[APEx Project Portal](../../instantiation/project_portal.md) and its [use cases](../../instantiation/usecases.qmd), where
15+
[APEx Project Web Portal](../../instantiation/project_portal.md) and its [use cases](../../instantiation/usecases.qmd), where
1616
you will discover how you can effectively use it within your project.
1717

1818
This user manual is designed for web managers and editors responsible for setting up, editing, and maintaining their project
1919
website. It provides you with a list of tutorials that focus on the most common tasks you may encounter while using the APEx
20-
Project Portal. Whether you are a newcomer or an experienced user, these tutorials will empower you to utilize the tool to
20+
Project Web Portal. Whether you are a newcomer or an experienced user, these tutorials will empower you to utilize the tool to
2121
its fullest potential.
2222

2323
Furthermore, as the portal is built on the [Drupal](https://new.drupal.org/home) framework, we recommend checking the

guides/project_portal/tutorials/1_login.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Login to the Project Portal and the Drupal content overview"
2+
title: "Login to the Project Web Portal and the Drupal content overview"
33
image: ../images/cover_login.png
44
lightbox: true
55
---
@@ -32,7 +32,7 @@ can manage:
3232
:::
3333
::: {.g-col-4}
3434

35-
![Project Portal login screen](../images/login_1.png){group="gallery-login"}
35+
![Project Web Portal login screen](../images/login_1.png){group="gallery-login"}
3636

3737
![APEx login screen](../images/login_2.jpg){group="gallery-login"}
3838

guides/project_portal/tutorials/3c_news.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ image: ../images/cover_news.png
44
lightbox: true
55
---
66

7-
The project portal allows you to add news items and an overview of all news items. The overview can be implemented via a
7+
The Project Web Portal allows you to add news items and an overview of all news items. The overview can be implemented via a
88
separate web page or you can also add a **news** paragraph on any web page to list the latest news items for example.
99

1010
## Add a news item

guides/project_portal/tutorials/4_menu.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Via the main navigation overview, which you can access when you navigate to **st
3434
administration toolbar, you can easily disable or enable main navigation (sub)menu items. Select the **Enabled** check to
3535
show the menu item in the main navigation or deselect the **Enabled** checkbox to hide the menu item in the main navigation.
3636

37-
## Edit the name of your project portal
37+
## Edit the name of your Project Web Portal
3838

3939
Upon instantiation of your project web portal, the name of your project will be set to display in the top left corner in
4040
the header section, left from the main menu navigation, and in the footer. The acronym and/or full name will use the primary

instantiation/accessibility.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@ title: Accessing your environment
44

55
Each instantiated component is assigned a dedicated URL following the convention:
66

7-
`https://<tool>.<project>.apex.esa.int.`
7+
`https://<tool>.<project>.apex.esa.int`
8+
9+
The only exception to this rule is the project web portal, which is hosted at:
10+
11+
`https://<project>.apex.esa.int`
812

913
This URL assignment process is fully automated by APEx, including the generation of the necessary security certificates.
10-
For example, if a project named `project-a` requests the instantiation of a user forum and a project portal, the following
14+
For example, if a project named `project-a` requests the instantiation of a user forum and a project web portal, the following
1115
URLs will be created:
1216

13-
`https://project-a.apex.esa.int` – the project portal
14-
`https://forum.project-a.apex.esa.int` – the project's user forum
17+
* `https://project-a.apex.esa.int` – the project web portal
18+
* `https://forum.project-a.apex.esa.int` – the project's user forum
1519

1620
This granular URL assignment ensures a clear separation between the different instantiated components, making them easy
1721
to manage and access. Additionally, as these URLs are publicly accessible, projects can seamlessly integrate the components

instantiation/app_code_server.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
title: Code Server IDE
33
---
44

5-
Code Server Interactive Development Environment - Tailored User Workspace
6-
7-
## Code Server overview
5+
## Overview
86

97
The Code Server Interactive Development Environment (IDE) capacity within the APEx Project Environments primarily leverages the power
108
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.
2119
Tailored specifically for EO tasks, this environment furnishes developers with an array of tools and libraries fine-tuned
2220
for programming languages and productivity plugins or extensions.
2321

24-
## Code Server software architecture
22+
## Software Architecture
2523

2624
The APEx Code Server solution is an Integrated Development Environment delivered as a cloud-based user workspace, tailored
2725
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
5452
Code Server serves as the core development environment, providing a powerful and flexible platform for coding and debugging,
5553
allowing developers to harness server-side computational power while maintaining a familiar interface.
5654

57-
### Code Server key features
55+
### Key Features
5856

5957
The APEx Code Server IDE includes several features that make it suitable for both individual researchers and teams
6058
working on EO research and applications.
@@ -74,15 +72,15 @@ complemented by a vast repository of extensions for virtually any language or fi
7472
Leverage integrated Git support, allowing team members to work on the same project by tracking changes and merging updates,
7573
helping to keep the code organised while avoiding conflicting code changes.
7674

77-
## Code Server showcase scenarios
75+
## Showcase Scenarios
7876

7977
The APEx Code Server IDE supports a variety of use cases, making it an essential tool for developers,
8078
researchers, and data scientists within the EO community. Some typical scenarios include:
8179

8280
* **Algorithm Development and Testing**\
8381
Researchers and developers can write, test, and debug new algorithms for processing
8482
satellite imagery or other EO data. For instance, a user might develop a script to detect deforestation using
85-
multi-temporal satellite images. To support the productivity of developers, the Code Server solution uses
83+
multi-temporal satellite images. To support the productivity of developers, the Code Server solution uses
8684
a mechanism of extensions. Code Server extensions are available from the Open VSX Registry.
8785

8886
::: {.callout-note}
@@ -98,7 +96,7 @@ leave the Code Server user interface
9896
* [Edit](https://continue.dev/docs/edit/how-to-use-it) is a convenient way to modify code without leaving your current file
9997
* [Actions](https://continue.dev/docs/actions/how-to-use-it) are shortcuts for common use cases.
10098

101-
This extension asks for API keys to use the models.
99+
This extension asks for API keys to use the models.
102100
This has been successfully tested and could be an option for the APEx use cases.
103101
:::
104102

instantiation/app_jupyterlab.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
title: JupyterLab IDE
33
---
44

5-
JupyterLab Interactive Development Environment - Tailored User Workspace
6-
7-
## JupyterLab overview
5+
## Overview
86

97
The JupyterLab Interactive Development Environment (IDE) capacity within the APEx Project Environments primarily leverages the power
108
of the [JupyterLab](#jupyterlab-software-architecture) software.
@@ -21,12 +19,12 @@ them to harness the computational power of remote servers.
2119
Tailored specifically for EO tasks, this environment furnishes developers with an array of tools and libraries fine-tuned
2220
for programming languages and productivity plugins or extensions.
2321

24-
## JupyterLab software architecture
22+
## Software Architecture
2523

2624
The JupyterLab setup encapsulates a web-based interactive development environment for Jupyter notebooks, code, and data.
2725
It is the user interface for Project Jupyter, offering a flexible user interface and more features than the classic notebook
2826
UI. It is a web application providing a development environment in which processing algorithms and services can be developed,
29-
tested, and debugged.
27+
tested, and debugged.
3028

3129
![The JupyterLab IDE in the current APEx workspaces offering ](images/applicationhub_jupyterlab.png)
3230

@@ -35,7 +33,7 @@ Julia, R, Haskell, Ruby, and Python (via the IPython kernel). It seamlessly adap
3533
developers to create, test, and deploy applications within isolated, replicable, and consistent environments, ensuring
3634
consistent behaviour across development, staging, and production phases.
3735

38-
### JupyterLab key features
36+
## Key Features
3937

4038
The APEx JupyterLab IDE includes several features that make it suitable for both individual researchers and teams
4139
working on EO research and applications.
@@ -53,18 +51,18 @@ various levels of support.
5351
Leverage integrated Git support, allowing team members to work on the same project by tracking changes and merging updates,
5452
helping to keep the code organized while avoiding conflicting code changes.
5553

56-
## JupyterLab showcase scenarios
54+
## Showcase Scenarios
5755

5856
The APEx JupyterLab IDE supports a variety of use cases, making it an essential tool for developers,
5957
researchers, and data scientists within the EO community. Some typical scenarios include:
6058

6159
* **Algorithm Development and Testing**\
6260
Researchers and developers can write, test, and debug new algorithms for processing
6361
satellite imagery or other EO data. For instance, a user might develop a script to detect deforestation using
64-
multi-temporal satellite images. To support the productivity of developers, both the JupyterLab solution use a mechanism of extensions.
62+
multi-temporal satellite images. To support the productivity of developers, both the JupyterLab solution use a mechanism of extensions.
6563

6664
::: {.callout-note}
67-
There is no GitHub Copilot extension available yet for JupyterLab.
65+
There is no GitHub Copilot extension available yet for JupyterLab.
6866

6967
See the [Code Server IDE](./app_code_server.md) page for more details on CoPilot extensions.
7068

@@ -86,7 +84,7 @@ working with notebooks, with its native support for data science, data visualisa
8684

8785
## Examples
8886

89-
@tbl-ide-examples showcases example projects that utilize the APEx JupyterLab IDE.
87+
@tbl-ide-examples showcases example projects that utilize the APEx JupyterLab IDE.
9088

9189
It is important to note that a valid APEx account and permissions from the project are required to access an environment.
9290

instantiation/app_qgis.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: QGIS as a Remote Desktop
33
---
44

5-
QGIS as a Remote Desktop - Tailored User Workspace
6-
75
## Overview
86

97
The Geographic Information System capacity within the APEx Project Environments primarily leverages the power
@@ -18,16 +16,15 @@ tasks or needing access to a consistent development environment from various loc
1816
The server-based nature ensures that users are not constrained by their local machine's hardware capabilities, allowing
1917
them to harness the computational power of remote servers.
2018

21-
22-
## QGIS software architecture
19+
## Software Architecture
2320

2421
The APEx QGIS workspace is a fully-fledged Geographic Information System delivered as a cloud-based user workspace, tailored
2522
to support the activities of Earth observation (EO) projects.
2623

2724
![QGIS on a Remote Desktop in the current APEx workspaces offering ](images/applicationhub_qgis.png)
2825

2926
Each QGIS workspace comes equipped with the free and open source software project hosted on QGIS.org association, as well
30-
as with a private data products catalogue. These features empower developer users to edit and build EO-based mapping products
27+
as with a private data products catalogue. These features empower developer users to edit and build EO-based mapping products
3128
and geospatial workflows, accelerating project outcomes within a dedicated, tool-rich environment.
3229

3330
### Key Features
@@ -53,7 +50,6 @@ Store, manage, and share QGIS projects with the ability to connect to external d
5350
Teams can work collaboratively on GIS projects, sharing data and resources in real-time. A group
5451
of data scientists might collaboratively develop crop yields scenario maps based on various data inputs.
5552

56-
5753
## Examples
5854

5955
Several examples are under development and will be added on this page.

instantiation/catalog.qmd

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Product Catalogue enables projects to create their own SpatioTemporal Asset
88
comprehensive metadata collection for efficient organisation and discovery of geospatial data assets. This information
99
is presented in a user-friendly JSON format.
1010

11-
![APEx Product Catalogue](images/stac_browser_1.jpg)
11+
![APEx Product Catalogue](images/stac_browser_1.png)
1212

1313
Instantiating a project-specific catalogue gives projects the freedom to use it for a range of purposes, from
1414
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:
4848

4949
### STAC Catalogue API
5050

51-
You will get a dedicated STAC catalog, hosted and managed by APEx. This gives you full control over the metadata,
51+
You will get a dedicated STAC catalogue, hosted and managed by APEx. This gives you full control over the metadata,
5252
without having to worry about IT aspects such as security, backup or monitoring the service. The catalogue supports
5353
creating both private and public collections.
5454

5555
#### Key Considerations
5656

57-
* **Data storage**: The STAC catalogue does _not_ include data storage. It is recommended to request object storage access
57+
* **Data storage**: The STAC catalogue does include limited data storage. It is recommended to request object storage access
5858
from one of the cloud providers in the Network of Resources (NoR).
59-
* M**etadata Creation**: The process of creating metadata is not automated. You will need to provide the metadata in
59+
* **Metadata Creation**: The process of creating metadata is not automated. You will need to provide the metadata in
6060
JSON
6161
format, giving you complete flexibility in choosing the STAC extensions that best suit your requirements.
6262

@@ -72,12 +72,12 @@ is not provided.
7272
### STAC Browser
7373

7474
In addition to the STAC Catalogue API, APEx provides a dedicated STAC Browser to support the visual exploration of your
75-
catalog's content. This browser is seamlessly integrated with the instantiated API and is automatically configured upon
75+
catalogue's content. This browser is seamlessly integrated with the instantiated API and is automatically configured upon
7676
initialization to display the results published in your STAC API.
7777

78-
![STAC Browser - Collections](images/stac_browser_1.jpg)
78+
![STAC Browser - Collections](images/stac_browser_1.png)
7979

80-
![STAC Browser - Collection Details](images/stac_browser_2.jpg)
80+
![STAC Browser - Collection Details](images/stac_browser_2.png)
8181

8282
#### Underlying Technology
8383

instantiation/documentation.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ A documentation portal can support several project scenarios, including:
5555

5656
The APEx Documentation Portal Service provides users with a streamlined template to initiate their documentation process.
5757
As changes are made, advanced automation tools ensure that the documentation is published seamlessly to a location that
58-
integrates effortlessly within your project portal. This service is most effective when used in conjunction with the
59-
[APEx Project Portal](./project_portal.md), maximizing the level of integration.
58+
integrates effortlessly within your project web portal. This service is most effective when used in conjunction with the
59+
[APEx Project Web Portal](./project_portal.md), maximizing the level of integration.
6060

6161
This documentation template includes the following features:
6262

0 commit comments

Comments
 (0)