Skip to content

Commit 13bcc68

Browse files
authored
Merge pull request #162 from ESA-APEx/structure_guides
Structure guides
2 parents 75f2a1f + c99a4f0 commit 13bcc68

18 files changed

+4266
-5020
lines changed

_quarto.yml

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,17 @@ website:
2121

2222
sidebar:
2323
style: "floating"
24-
collapse-level: 2
2524
contents:
2625
- href: index.qmd
2726
text: Welcome
2827
# - href: eo_service_usage.qmd
29-
- text: On-demand EO services
28+
- section: On-demand EO services
3029
contents:
3130
- href: eo_service_usage/openeo_usage.md
3231
text: Using openEO service
3332
- href: propagation/platforms.md
3433
- href: instantiation/index.md
35-
text: Project Environments
34+
section: Project Environments
3635
contents:
3736
- href: instantiation/usecases.qmd
3837
text: Use Cases
@@ -47,7 +46,7 @@ website:
4746
- href: instantiation/documentation.qmd
4847
- href: instantiation/forum.md
4948
- href: propagation/index.qmd
50-
text: Algorithm Support
49+
section: Algorithm Support
5150
contents:
5251
- href: propagation/ondemandservices.qmd
5352
- href: propagation/usecases.md
@@ -58,33 +57,46 @@ website:
5857
- href: propagation/enhancement.md
5958
- href: propagation/toolboxcloud.md
6059
- href: propagation/intercomparison.md
61-
- text: Guides
60+
- section: Developer Guides
6261
contents:
63-
- href: guides/account.md
64-
- href: guides/token.md
65-
text: Creating APEx single sign-on token
66-
- href: guides/udp_writer_guide.qmd
67-
text: Creating openEO based services
68-
- href: guides/eoap_writer_guide.md
69-
text: Creating EOAP based services
70-
- href: guides/upscaling_openeo.ipynb
71-
text: Upscaling openEO based services
72-
- href: guides/stac_catalog_ingest.ipynb
73-
text: Ingesting STAC metadata in APEx Product Catalogue
74-
- href: guides/catalog_openeo.ipynb
75-
text: Linking APEx STAC catalogue with an openEO service
62+
- section: Authentication
63+
contents:
64+
- href: guides/account.md
65+
- href: guides/token.md
66+
text: Creating APEx single sign-on token
67+
- section: openEO
68+
contents:
69+
- href: guides/udp_writer_guide.qmd
70+
text: Creating openEO based services
71+
- href: guides/upscaling_openeo.ipynb
72+
text: Upscaling openEO based services
73+
- section: EOAP
74+
contents:
75+
- href: guides/eoap_writer_guide.md
76+
text: Creating EOAP based services
77+
- section: APEx Product Catalogue
78+
contents:
79+
- href: guides/stac_catalog_ingest.ipynb
80+
text: Ingesting STAC metadata in APEx Product Catalogue
81+
- href: guides/catalog_openeo.ipynb
82+
text: Linking APEx Product Catalogue with an openEO service
83+
- section: APEx Algorithm Services Catalogue
84+
contents:
85+
- href: guides/algorithm_services_catalogue.qmd
86+
- href: guides/algorithm_services_catalogue_benchmarks.qmd
7687
- href: guides/file_formats.qmd
7788
text: File format recommendations
78-
- href: guides/geospatial_explorer_config_guide.md
79-
text: Configuring the Geospatial Explorer
80-
- href: guides/geospatial_explorer_guide.md
81-
text: Using the Geospatial Explorer
89+
- section: User Guides
90+
contents:
91+
- href: guides/geospatial_explorer/index.qmd
92+
contents:
93+
- auto: guides/geospatial_explorer/tutorials/*.qmd
8294
- href: guides/project_portal/index.qmd
8395
contents:
8496
- auto: guides/project_portal/tutorials/*.qmd
8597

8698
- href: interoperability/index.md
87-
text: Interoperability and Compliance Guidelines
99+
section: Interoperability and Compliance Guidelines
88100
contents:
89101
- href: interoperability/definitions.qmd
90102
- href: propagation/service_development.qmd
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Registering your service
3+
jupyter: python3
4+
execute:
5+
echo: false
6+
---
7+
8+
```{python}
9+
#| output: asis
10+
import requests
11+
url = "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/main/docs/catalogue.md"
12+
r = requests.get(url)
13+
r.raise_for_status()
14+
15+
# Convert images to use absolute URLs
16+
base_url = "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/main/docs/"
17+
content = r.text.replace("](images/", f"]({base_url}images/")
18+
19+
print(content)
20+
```
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Creating benchmarks for your service
3+
jupyter: python3
4+
execute:
5+
echo: false
6+
---
7+
8+
```{python}
9+
#| output: asis
10+
import requests
11+
url = "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/main/docs/benchmarking.md"
12+
r = requests.get(url)
13+
r.raise_for_status()
14+
15+
# Convert images to use absolute URLs
16+
base_url = "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/main/docs/"
17+
content = r.text.replace("](images/", f"]({base_url}images/")
18+
19+
print(content)
20+
```

0 commit comments

Comments
 (0)