Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Absolute internal references instead of relative ones #611

Open
soxofaan opened this issue Sep 11, 2024 · 0 comments
Open

Absolute internal references instead of relative ones #611

soxofaan opened this issue Sep 11, 2024 · 0 comments

Comments

@soxofaan
Copy link
Collaborator

I noticed there are quite a lot of internal references in the markdown files using absolute https://documentation.dataspace.copernicus.eu/... links instead of proper relative internal references (e.g. [registration](../../../Registration.qmd)).

This makes the docs brittle, you don't get build-time warnings/errors about broken references, and makes it confusing to test non-production builds of the docs.

examples I found:

$ rg https://documentation.dataspace.copernicus.eu --glob '*.*md'
Quotas.qmd
197:  ⁴ After reaching this limit, the Access Token must either be refreshed by using the <a href= "https://documentation.dataspace.copernicus.eu/APIs/OData.html#product-download" target="_blank">Refresh Token</a> or be re-generated.
205:  ⁸ Similar principles apply for all SentinelHub APIs while the differences and details are covered in the <a href= "https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Overview/ProcessingUnit.html" target="_blank">Processing Unit</a> section of our documentation. Note that there are APIs that are not available to Copernicus General Users such as Sentinel Hub Batch Processing API.

Data/Others/Sentinel2_L1C_baseline.qmd
18:These products can be differentiated by the [OData](https://documentation.dataspace.copernicus.eu/APIs/OData.html#query-by-attributes){target="_blank"} and [OpenSearch](https://catalogue.dataspace.copernicus.eu/resto/api/collections/Sentinel2/describe.xml){target="_blank"} **processingBaseline** attribute. Processing Baseline is presented on Copernicus Browser as a "Processor version" attribute.

Data/Others/Sentinel2_Mosaic_access.qmd
16:Sentinel-2 Level 3 Quarterly Mosaics are onboarded to Sentinel Hub as a BYOC data collection. To access the data, you will need the specific pieces of information listed below, for general information about how to access BYOC collection visit our [Data BYOC page](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/Byoc.html){target="_blank"}.
57:      <td>The mask of data/no data pixels ([more](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/UserGuides/Datamask.html)).</td>
67:The request below is written in Python. To execute it, you need to create an OAuth client as is explained [here](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Overview/Authentication.html#python). It is named `oauth` in this example.

Data/Others/Sentinel2_Mosaic_Algorithm.qmd
52:Sentinel-2 Level 3 Quarterly Mosaics are onboarded to Sentinel Hub as a BYOC data collection. To access the data, you will need the specific pieces of information listed below, for general information about how to access BYOC collections visit our [Data BYOC page](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/Byoc.html){target="_blank"}.
93:      <td>The mask of data/no data pixels ([more](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/UserGuides/Datamask.html){target="_blank"}).</td>
103:The request below is written in python. To execute it, you need to create an OAuth client as is explained [here](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Overview/Authentication.html#python){target="_blank"}. It is named `oauth` in this example.

Data/Others/Sentinel1_Mosaic_Algorithm.qmd
18:Sentinel-1 GRD data, as offered and pre-processed in Sentinel Hub, serves as input for the generation of mosaics. The preprocessing steps made in Sentinel Hub are explained in detail in the [Sentinel Hub documentation](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/S1GRD.html#processing-chain){target="_blank"}. Here, we are only listing the main processing steps applied to the input data before mosaicking:
81:Sentinel-1 Level 3 Monthly Mosaics are onboarded to Sentinel Hub as a BYOC data collection. To access the data, you will need the specific pieces of information listed below, for general information about how to access BYOC collections visit our [Data BYOC page](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/Byoc.html){target="_blank"}.
109:      <td>The mask of data/no data pixels ([more](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/UserGuides/Datamask.html))</td>
119:The request below is written in Python. To execute it, you need to create an OAuth client as is explained [here](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Overview/Authentication.html#python). It is named `oauth` in this example.
215:      <td>The mask of data/no data pixels ([more](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/UserGuides/Datamask.html))</td>
225:The request below is written in Python. To execute it, you need to create an OAuth client as is explained [here](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Overview/Authentication.html#python). It is named `oauth` in this example.

Data/Others/Sentinel1_Mosaic_access.qmd
16:Sentinel-1 Level 3 Monthly Mosaics are onboarded to Sentinel Hub as a BYOC data collection. To access the data, you will need the specific pieces of information listed below, for general information about how to access BYOC collections visit our [Data BYOC page](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/Byoc.html){target="_blank"}.
44:      <td>The mask of data/no data pixels ([more](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/UserGuides/Datamask.html))</td>
54:The request below is written in Python. To execute it, you need to create an OAuth client as is explained [here](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Overview/Authentication.html#python). It is named `oauth` in this example.
150:      <td>The mask of data/no data pixels ([more](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/UserGuides/Datamask.html))</td>
160:The request below is written in Python. To execute it, you need to create an OAuth client as is explained [here](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Overview/Authentication.html#python). It is named `oauth` in this example.

Applications/PlazaDetails/ExecuteService.qmd
39:| [Documentation](https://documentation.dataspace.copernicus.eu/APIs/openEO/openEO.html){target="_blank"} |
47:* [JavaScript](https://documentation.dataspace.copernicus.eu/APIs/openEO/JavaScript_Client/JavaScript.html){target="_blank"}
48:* [Python](https://documentation.dataspace.copernicus.eu/APIs/openEO/Python_Client/Python.html){target="_blank"}
49:* [R](https://documentation.dataspace.copernicus.eu/APIs/openEO/R_Client/R.html){target="_blank"}

Applications/Browser.qmd
11:Currently you need a free account to use the Browser. **New user? Register an account by following the steps [here](https://documentation.dataspace.copernicus.eu/Registration.html){target="_blank"}**. Remember to save your login credentials for the next time you want to log in to the Browser. The Copernicus Browser is also available in multiple languages.

Data/SentinelMissions/Sentinel1.qmd
38:## [Sentinel-1 RTC](https://documentation.dataspace.copernicus.eu/Data/Additional.html#sentinel-1-rtc)
39:[Sentinel-1 RTC](https://documentation.dataspace.copernicus.eu/Data/Additional.html#sentinel-1-rtc) (Radiometric Terrain Correction) SAR Backscatter is a product processed from Sentinel-1 GRD data and compliant with [CEOS Analysis Ready Data for Land (CARD4L) specifications](https://ceos-dev.ceos.org/ard/){target="_blank"} for Normalised Radar Backscatter (NRB) products. Orthorectification is based on Copernicus DEM and no speckle filtering is applied. ([Additional product information](https://sentinels.copernicus.eu/web/sentinel/sentinel-1-ard-normalised-radar-backscatter-nrb-product){target="_blank"})
41:## [Sentinel Hub processing options](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/S1GRD.html#processing-options)
43:Sentinel Hub offers the following processing options in the [Sentinel-1 GRD processing chain](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/S1GRD.html#processing-chain):
45:- [Backscatter coefficients](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/S1GRD.html#processing-options):
52:- [Lee Speckle Filtering](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/S1GRD.html#processing-options) applied on source data after calibration and noise removal
53:- [Radiometric Terrain Correction (RTC)](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/S1GRD.html#processing-options) can be enabled by setting the backscatter coefficient to *gamma0 (terrain)* and enabling *orthorectification*
54:- [Orthorectification](https://documentation.dataspace.copernicus.eu/APIs/SentinelHub/Data/S1GRD.html#processing-options) with Range-Doppler terrain correction using one of the following DEMs:
84:## [On-demand processing options](https://documentation.dataspace.copernicus.eu/APIs/On-Demand%20Production%20API.html)
86:Processing of CARD-BS and COH6/COH12 products can be requested [on demand](https://documentation.dataspace.copernicus.eu/APIs/On-Demand%20Production%20API.html):
88:- [Sentinel-1 (CARD-BS) BackScatter](https://documentation.dataspace.copernicus.eu/APIs/On-Demand%20Production%20API.html)
93:- [Sentinel-1 (CARD-COH) Coherence](https://documentation.dataspace.copernicus.eu/APIs/On-Demand%20Production%20API.html)

Data/ComplementaryData/SMOS.qmd
46:•	[OpenSearch](https://documentation.dataspace.copernicus.eu/APIs/OpenSearch.html){target="_blank"}\
47:•	[OData](https://documentation.dataspace.copernicus.eu/APIs/OData.html){target="_blank"}

Applications/DataWorkspace.qmd
73:Downloading from the catalogue is done in the same way as described in the <a href="https://documentation.dataspace.copernicus.eu/APIs/OData.html#product-download" target="_blank">OData Product Download</a> documentation.
125:You will find both the product on which the product has been processed and the product after processing. Downloading from the catalogue is done in the same way as described in the <a href="https://documentation.dataspace.copernicus.eu/APIs/OData.html#product-download" target="_blank">OData Product Download</a> documentation.

Applications/PlazaDetails/PublishService.qmd
37:To get familiar with openEO, it is recommended to begin with the [basic introduction](https://documentation.dataspace.copernicus.eu/APIs/openEO/openEO.html){target="_blank"} of openEO. Developers can then share their algorithms as services on the openEO Algorithm Plaza. For deploying an openEO algorithm as a service, developers can utilize the ['user defined process'](https://open-eo.github.io/openeo-python-client/udp.html){target="_blank"} functionality.

Data/ComplementaryData/Landsat7.qmd
46:•	[OpenSearch](https://documentation.dataspace.copernicus.eu/APIs/OpenSearch.html){target="_blank"}\
47:•	[OData](https://documentation.dataspace.copernicus.eu/APIs/OData.html){target="_blank"}

Data/Others/Sentinel2_L2A_baseline.qmd
24:These products can be differentiated by the [OData](https://documentation.dataspace.copernicus.eu/APIs/OData.html#query-by-attributes){target="_blank"} and [OpenSearch](https://catalogue.dataspace.copernicus.eu/resto/api/collections/Sentinel2/describe.xml){target="_blank"} **(origin)** attribute (ESA or CloudFerro) and by the **'processingBaseline'** attribute. Processing Baseline is presented on Copernicus Browser as a "Processor version" attribute.

Data/ComplementaryData/Landsat8.qmd
44:•	[OpenSearch](https://documentation.dataspace.copernicus.eu/APIs/OpenSearch.html){target="_blank"}\
45:•	[OData](https://documentation.dataspace.copernicus.eu/APIs/OData.html){target="_blank"}

2FA.qmd
10:If you encounter any issues during the registration process, please refer to the documentation [User registration and authentication](https://documentation.dataspace.copernicus.eu/Registration.html#step-1-registration).

Data/ComplementaryData/MERIS.qmd
29:- <a href="https://documentation.dataspace.copernicus.eu/APIs/OpenSearch.html">OpenSearch</a> <br>
30:- <a href="https://documentation.dataspace.copernicus.eu/APIs/OData.html">OData</a>

README.md
9:| publish | Branch that contains the current release of the documentation potal | https://documentation.dataspace.copernicus.eu/ |

Data/ComplementaryData/Landsat5.qmd
46:•	[OpenSearch](https://documentation.dataspace.copernicus.eu/APIs/OpenSearch.html){target="_blank"}\
47:•	[OData](https://documentation.dataspace.copernicus.eu/APIs/OData.html){target="_blank"}

APIs/STAC.qmd
79:Search for items is possible among all collections [Items Search in all STAC Collections](https://documentation.dataspace.copernicus.eu/APIs/STAC.html#items-search-in-all-stac-collections) or in one specified collection only [Items Search in a STAC Collection](https://documentation.dataspace.copernicus.eu/APIs/STAC.html#items-search-in-a-stac-collection).
103:By default, the catalogue will limit the number of shown items to 20. It can be changed by filtering with the limit option as described below [Limit option](https://documentation.dataspace.copernicus.eu/APIs/STAC.html#limit-option).

ResearchNetwork.qmd
19:Use the [documentation](https://documentation.dataspace.copernicus.eu/Home.html){target="_blank"} portal.
24:Follow the steps on [User registration and authentication](https://documentation.dataspace.copernicus.eu/Registration.html){target="_blank"}.
29:To get the token you can follow the steps on [Access token](https://documentation.dataspace.copernicus.eu/APIs/Token.html){target="_blank"}.
70:To access EO data via S3, please refer to [S3 Access](https://documentation.dataspace.copernicus.eu/APIs/S3.html){target="_blank"}.

FAQ.qmd
44:            <li><a href="https://documentation.dataspace.copernicus.eu/Quotas.html">Information about quotas</a> for specific services</li>
88:    <p>The <a href="https://documentation.dataspace.copernicus.eu/Roadmap/DataTable.html">Data Roadmap</a> shows how the Copernicus Data Space Ecosystem will be continously enhanced in terms of available data.</p>
188:        Also please refer to the  <a href="https://documentation.dataspace.copernicus.eu/APIs/OData.html">OData</a> section of our documentation for more information on Access and Refresh Tokens.<br></p>
203:    <p>Yes, <a href= "https://documentation.dataspace.copernicus.eu/APIs/STAC.html" target="_blank">STAC Product Catalog</a> is already available. However there may be issues with using the current version with generic STAC libraries. Our dedicated teams are actively working on its development to ensure a seamless experience for all users. Nevertheless it already supports basic product search.</p>
213:    <p>Please refer to the <a href= "https://documentation.dataspace.copernicus.eu/APIs/S3.html" target="_blank">Access to EO Data via S3</a> page for the guidance on generating S3 access and secret keys.</p>
287:    <p>Visit our [documentation page](https://documentation.dataspace.copernicus.eu/Applications/Browser.html) for details about the Browser.</p>
327:    <p>In Copernicus Browser, you can view two kinds of statistical information for your imagery: a line chart of values through time for either a point or a polygon, and a histogram of values (see the chapter Statistical Analysis on our [Copernicus Browser page](https://documentation.dataspace.copernicus.eu/Applications/Browser.html#statistical-analysis)). To enable statistical features, an evalscript supporting statistical API should be used in your layers.<br><br>

APIs/openEO/openEO.qmd
37:Nevertheless, if you are unfamiliar with programming, you could start using the [web-based editor for openEO](#). It supports visual modelling of your algorithms and simplified JavaScript-based access to the openEO workflows and providers. An overview of the openEO web-editor is available in the [Applications](https://documentation.dataspace.copernicus.eu/Applications.html) section of this documentation.

APIs/Subscriptions.qmd
138:                <td style="text-align: left; vertical-align: middle">The filter parameters of the Subscription (refers to the $filter= parameter of any Products? query). The same filtering parameters as described for [OData Data Sapce Catalogue](https://documentation.dataspace.copernicus.eu/APIs/OData.html#filter-option) are available.</td>
210:Subscriptions enables the same filtering parameters as described for [OData Data Sapce Catalogue](https://documentation.dataspace.copernicus.eu/APIs/OData.html#filter-option). All filters should be provided in `FilterParam` field.
535:If client' notification endpoint is not submitted, then [PULL subscription](https://documentation.dataspace.copernicus.eu/APIs/Subscriptions.html#pull-subscriptions) will be created.
584:                <td style="text-align: left; vertical-align: middle">The filter parameters of the Subscription (refers to the $filter= parameter of any Products? query). The same filtering parameters as described for [OData Data Sapce Catalogue](https://documentation.dataspace.copernicus.eu/APIs/OData.html#filter-option) are available.</td>
647:Subscriptions enables the same filtering parameters as described for [OData Data Sapce Catalogue](https://documentation.dataspace.copernicus.eu/APIs/OData.html#filter-option). All filters should be provided in `FilterParam` field.

APIs/OData.qmd
418:- ***[Attribute.Name]*** is the attribute name which can take multiple values depending on collection; acceptable values for the attribute name can be checked at the specified endpoints for each collection, as provided in [List of OData query attributes](https://documentation.dataspace.copernicus.eu/APIs/OData.html#list-of-odata-query-attributes-by-collection).
1030:For downloading products in their native format (as zipped files) you need to proceed with the standard authorization as for [Product Download](https://documentation.dataspace.copernicus.eu/APIs/OData.html#product-download).
1099:the OData Products endpoint [OData Query structure](https://documentation.dataspace.copernicus.eu/APIs/OData.html#query-structure) with the change in the endpoint URL 'Products' to 'DeletedProducts'.
1118:For more information, please go to [OData Query structure](https://documentation.dataspace.copernicus.eu/APIs/OData.html#query-structure)
1150:built as explained [Filter option](https://documentation.dataspace.copernicus.eu/APIs/OData.html#filter-option)
1266:For available collections, please refer to [Query Collection of Products](https://documentation.dataspace.copernicus.eu/APIs/OData.html#query-collection-of-products). Also, please note that it is possible that none of the products have been deleted from the available collections.
1316:build a filter with the specified structure as defined [Query Collection of Products](https://documentation.dataspace.copernicus.eu/APIs/OData.html#query-collection-of-products).
1338:Orderby option works the same way as explained [Orderby option](https://documentation.dataspace.copernicus.eu/APIs/OData.html#orderby-option).
1403:Skip option can be used as defined [Skip option](https://documentation.dataspace.copernicus.eu/APIs/OData.html#skip-option).
1427:Top option can be used as defined [Top option](https://documentation.dataspace.copernicus.eu/APIs/OData.html#top-option).
1450:Count option can be used as defined [Count option](https://documentation.dataspace.copernicus.eu/APIs/OData.html#count-option)

APIs/Others/UpcomingChanges.qmd
12:Please be informed that [OData Catalogue API Response Format Change](https://documentation.dataspace.copernicus.eu/APIs/Others/UpcomingChanges.html#odata-catalogue-api-response-format-change) was rescheduled to **24th September 2024**. Therefore, all changes will be implemented starting from **24th September 2024**.
2258:Please be informed that the OpenSearch API error handling update was successfully implemented on **24th October 2023**. The details of the change are explained [here](https://documentation.dataspace.copernicus.eu/APIs/Others/ReleaseNotes.html#opensearch-api-error-handling-update-2023-10-24).
2262:Please be informed that the OpenSearch API error handling update has been rescheduled for **24th October 2023**. The details of the change are explained [here](https://documentation.dataspace.copernicus.eu/APIs/Others/UpcomingChanges.html#opensearch-api-error-handling-update).
2266:Please be informed that the OpenSearch API error handling update is planned for **17th of October 2023**. The details of the change are explained [here](https://documentation.dataspace.copernicus.eu/APIs/Others/UpcomingChanges.html#opensearch-api-error-handling-update).

APIs/SentinelHub/Data/S1GRD.qmd
8:[here](https://documentation.dataspace.copernicus.eu/Data/SentinelMissions/Sentinel1.html). Sentinel Hub offers [Sentinel-1 Level 1
10:products](https://documentation.dataspace.copernicus.eu/Data/SentinelMissions/Sentinel1.html#sentinel-1-level-1-ground-range-detected-grd).

APIs/SentinelHub/Data/S3OLCI.qmd
8:[here](https://documentation.dataspace.copernicus.eu/Data/SentinelMissions/Sentinel3.html). Sentinel Hub offers [Sentinel-3 OLCI Level
9:1B](https://documentation.dataspace.copernicus.eu/Data/SentinelMissions/Sentinel3.html#sentinel-3-olci-level-1) products.

APIs/SentinelHub/Data/S3SLSTR.qmd
8:[here](https://documentation.dataspace.copernicus.eu/Data/SentinelMissions/Sentinel3.html). Sentinel Hub offers [Sentinel-3 SLSTR Level
9:1B](https://documentation.dataspace.copernicus.eu/Data/SentinelMissions/Sentinel3.html#sentinel-3-slstr-level-1) products.

APIs/SentinelHub/Data/S2L2A.qmd
9:2A](https://documentation.dataspace.copernicus.eu/Data/SentinelMissions/Sentinel2.html#sentinel-2-level-2a-surface-reflectance) products.

APIs/openEO/Glossary.qmd
39:User-defined processes can for example be shared in the [openEO algorithm plaza](https://marketplace-portal.dataspace.copernicus.eu/){target="_blank"}. You can find more information in [this page](https://documentation.dataspace.copernicus.eu/Applications/AlgorithmPlaza.html)

APIs/S3.qmd
17:This endpoint will provide access to EO data which is stored on the Object Storage. A Global Service Load Balancer (GSLB) directs the request to either CloudFerro Cloud or OpenTelekom Cloud (OTC) S3 endpoint. The decision is based on the location of the DNS resolver. ([Global Service Load Balancer](https://documentation.dataspace.copernicus.eu/ResearchNetwork.html#global-service-load-balancer){target="_blank"})
132:If you dont have an account, you can register via following <a href="https://documentation.dataspace.copernicus.eu/Registration.html">link</a>.

APIs/On-Demand Production API.qmd
187:More information on the tokens and authentication can be found here: [https://documentation.dataspace.copernicus.eu/APIs/OData.html#product-download](https://documentation.dataspace.copernicus.eu/APIs/OData.html#product-download){target="blank"}
471:More information and examples of using the OData APIs of the Copernicus Dataspace Ecosystem can be found above and in the [Catalogue API documentation](https://documentation.dataspace.copernicus.eu/APIs/OData.html){target="blank"}

@soxofaan soxofaan changed the title Absolute internal referenecs Absolute internal references instead of relative ones Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant