diff --git a/pages/Getting started with EarthCODE/Troubleshooting and Support.md b/pages/Getting started with EarthCODE/Frequently Asked Questions.md similarity index 54% rename from pages/Getting started with EarthCODE/Troubleshooting and Support.md rename to pages/Getting started with EarthCODE/Frequently Asked Questions.md index 00530caf..cabfaef4 100644 --- a/pages/Getting started with EarthCODE/Troubleshooting and Support.md +++ b/pages/Getting started with EarthCODE/Frequently Asked Questions.md @@ -1,20 +1,24 @@ --- order: 6 --- -# Troubleshooting and Support +# Frequently Asked Questions :::warning 🛠️ Page Under Development Content is being actively developed and updated for this page. EarthCODE's documentation is a living document and will be continuously updated with detailed reviews. ::: -This sub-section provides solutions to common issues that users may encounter while configuring tools and platforms. +This sub-section provides solutions to common issues that users may encounter. -## Frequently Asked Questions + + + +## Open Science Catalog
-Can I use Google Earth Engine (GEE) within EarthCODE? +How do I add entries to the Open Science Catalog? -Google Earth Engine is not yet one of the integrated EarthCODE platforms, and there are no short‑term plans to add it. You can still process data in GEE and then manually publish the resulting datasets and workflows to EarthCODE. We have logged the community’s interest in a future GEE integration. +Please check the [documentation](../Technical%20Documentation/Open%20Science%20Catalog%20(OSC)/Contributing%20to%20the%20Open%20Science%20Catalog.md) or directly the [examples](https://esa-earthcode.github.io/examples/index-2/).
+
Can I publish pre-trained models or anonymized data? @@ -22,64 +26,64 @@ Yes. The FAIR principles do **not** require assets to be fully open, so you may
-How does EarthCODE differ from the GEO Knowledge Hub? Will I need to register my outputs in multiple places? +Can I add proprietary datasets to the OSC ? + +Yes, provided the correct licensing information is specified. -EarthCODE is ESA’s default environment for ESA‑funded projects, providing an ecosystem of integrated platforms for developing, executing and sharing open science. Once your data and workflows are FAIR, the same metadata can be exposed to other registries—such as the GEO Knowledge Hub—without duplicating effort.
+
-When will EarthCODE be released? +I am not an ESA funded project. Can I publish to the OSC? -The first set of integrated platforms will be available by **30 June 2025**. Full interoperability between platforms is scheduled for **September 2025**. Additional platforms will be integrated on a rolling basis. +Currently, this is decided on a case by case basis. Contact the EarthCODE team with details about your usecase to get more specific information. -*Stay informed:* -- [EarthCODE website](https://earthcode.esa.int/) -- [Forum](https://discourse-earthcode.eox.at/) -- [LinkedIn](https://www.linkedin.com/company/106663043) -- [Newsletter](https://esacontact.esa.int/ESA_EO_OpenScience_Subscribe/)
-
-How do I integrate a platform with EarthCODE? -ESA issues “Best‑Practice” procurement tenders periodically. Responding to a tender is the route to integration. Requirements include: +## ESA Project Results Repository (PRR) -- GitHub‑based single sign‑on -- Automated publication of data and workflows to the Open Science Catalog (OSC) -- Connection to the ESA Project Results Repository (PRR) for long‑term storage -- Ability to execute published experiments on the platform -- Registration in the Network of Resources (NoR) discovery portal -- User documentation and a service‑level agreement (SLA) +
+How do I upload my data to the PRR? -The latest call is described on the [EarthCODE blog](https://earthcode.esa.int/blog/itt-bp2). +Please check the [documentation](../Technical%20Documentation/ESA%20Project%20Results%20Repository%20(PRR)/index.md) or directly the [examples](https://esa-earthcode.github.io/examples/index-1/).
-What is the relationship between EarthCODE and APEx? +Can I update my data periodically? + +The PRR's primarily serves as long-term storage for finished project outcomes, that have been verified by the corresponding Technical Officer. However, new products can be added on some occasions. Contact the EarthCODE team with details about your usecase to get more specific information. -EarthCODE focuses on cataloguing and sharing research outputs. APEx takes mature workflows from EarthCODE and scales them into production‑ready services.
-Will EarthCODE make large‑scale Sentinel‑2 processing easier? +I am not an ESA funded project. Can I upload my data to the ESA PRR? + +The PRR primarily serves ESA-related projects, however other projects such as those from the ESA member state space agencies can also apply. Contact the EarthCODE team with details about your usecase to get more specific information. -Yes. The integrated platforms provide cloud‑native access to Sentinel‑2 and other large datasets, allowing you to run algorithms where the data reside.
+## Platforms +
-Where can I get help integrating my project? +How do I get access to EarthCODE platforms? -- Read the platform documentation and training materials. -- Ask the community in the [EarthCODE Forum](https://discourse-earthcode.eox.at/)—the `#onboarding` category is a good starting point. -- For personalised assistance, e‑mail **earthcode‑support@esa.int**. +First, select the appropriate platform for your use case, see the [platform section](../Technical%20Documentation/Platforms/) for more information, and then contact the platform provider directly.
+
Are non‑ESA projects eligible for NoR credits? Yes, but priority is given to ESA‑funded projects.
+
+Can I use Google Earth Engine (GEE) within EarthCODE? + +Google Earth Engine is not yet one of the integrated EarthCODE platforms, and there are no short‑term plans to add it. You can still process data in GEE and then manually publish the resulting datasets and workflows to EarthCODE. We have logged the community’s interest in a future GEE integration. +
+
Can I transfer unused NoR credits between platforms? @@ -87,54 +91,62 @@ Not yet. Credit transfer is on our roadmap, but is complex because each platform
-## Common Issues and Solutions -A list of common problems users might encounter and how to resolve them. +## Community -## Issues Regarding EarthCODE -For these types of issues, the EarthCODE project team will directly support you. Please find the relevant types of issues, and their common solutions below. +
+When will EarthCODE be released officially? -### EarthCODE Portal -Problems with accounts, GitHub authentication, portal navigation, and user roles (who can contribute vs. who can view). For issues related to th +The first set of integrated platforms will be available by **30 June 2025**. Full interoperability between platforms is scheduled for **September 2025**. Additional platforms will be integrated on a rolling basis. -### EarthCODE Discourse and Community -Forum access, subscribing to newsletters and community guidelines. +*Stay informed:* +- [EarthCODE website](https://earthcode.esa.int/) +- [Forum](https://discourse-earthcode.eox.at/) +- [LinkedIn](https://www.linkedin.com/company/106663043) +- [Newsletter](https://esacontact.esa.int/ESA_EO_OpenScience_Subscribe/) +
-### Best Practices -Problems with applying code, data, and workflow best practices standards, questions about publishing private data, metadata validation, FAIR compliance. +## EarthCODE questions -### Open Science Catalog -Problems related to finding, accessing or executing data and workflows on the Open Science Catalog. +
+How does EarthCODE differ from the GEO Knowledge Hub? Will I need to register my outputs in multiple places? -### EarthCODE APIs -Using EarthCODE REST/OAuth APIs (authentication, rate limits, endpoints), troubleshooting common errors and versioning. +EarthCODE is ESA’s default environment for ESA‑funded projects, providing an ecosystem of integrated platforms for developing, executing and sharing open science. Once your data and workflows are FAIR, the same metadata can be exposed to other registries—such as the GEO Knowledge Hub—without duplicating effort. +
-### Getting Help -Information on how to contact support, access user forums, or refer to the documentation for more help. -The first place to go for issues is the **EarthCODE Discourse Forum - Technical Support Category** https://discourse-earthcode.eox.at/c/technical-support/8. If appropriate, please create a post with your problem and we will promptly answer there. +
+How do I integrate a platform with EarthCODE? -- **EarthCODE General, Open Science Catalog and Portal, Discourse Support** - - Email: earth-code@esa.int - - If you have found a bug or would like to suggest a feature, you can raise GitHub Issues on the following pages: - - Portal - https://github.com/ESA-EarthCODE/portal/issues - - Open Science Catalog - https://github.com/EOEPCA/open-science-catalog-metadata-staging/issues - - Documentation (this site) - https://github.com/ESA-EarthCODE/documentation/issues +ESA issues “Best‑Practice” procurement tenders periodically. Responding to a tender is the route to integration. Requirements include: +- GitHub‑based single sign‑on +- Automated publication of data and workflows to the Open Science Catalog (OSC) +- Connection to the ESA Project Results Repository (PRR) for long‑term storage +- Ability to execute published experiments on the platform +- Registration in the Network of Resources (NoR) discovery portal +- User documentation and a service‑level agreement (SLA) -## Issues Regarding EarthCODE Platforms -For these types of issues, the EarthCODE platform providers will directly support you. Please find the relevant types of issues, and their common solutions below. Refer to the [specific platform pages](../Technical%20Documentation/Platforms/) for additional details. +The latest call is described on the [EarthCODE blog](https://earthcode.esa.int/blog/itt-bp2). +
+ +
+What is the relationship between EarthCODE and APEx? + +EarthCODE focuses on cataloguing and sharing research outputs. APEx takes mature workflows from EarthCODE and scales them into production‑ready services. +
-### Datasets -Supported file formats, where and how data are stored, cloud‑based access, and instructions for preparing and uploading datasets. -### Computational Research -Selecting and accessing compute platforms (DeepESDL, Euro Data Cube, CDSE, etc.), allocation of credits, and others. Executing, reusing or accessing workflows on platforms. +## Additional Support +### EarthCODE, Open Science Catalog, ESA Project Results Repository or Discourse Support + - The first place to go for issues is the **EarthCODE Discourse Forum - Technical Support Category** https://discourse-earthcode.eox.at/c/technical-support/8. If appropriate, please create a post with your problem and we will promptly answer there. + - Alternatively, you can email us at: earth-code@esa.int -## Issues with ESA Project Results Repository -Typically the platform provider will handle issues related to uploading your results to the ESA PRR if you are using a platform to publish to EarthCODE and you should get in touch with the relevant platform support team. + - If you have found a bug or would like to suggest a feature, you can raise GitHub Issues on the following pages: + - Portal - https://github.com/ESA-EarthCODE/portal/issues + - Open Science Catalog - https://github.com/EOEPCA/open-science-catalog-metadata-staging/issues + - Documentation (this site) - https://github.com/ESA-EarthCODE/documentation/issues -If however you want to share your work through the ESA PRR and are NOT using a platform, these issues should be addressed with the EarthCODE team. Please use the contact details provided in the [getting help section](./Troubleshooting%20and%20Support.md#getting-help) above. -- **Platform Helpdesks and Support Channels (Platform Providers)** - - Please refer to the [specific platform page](../Technical%20Documentation/Platforms/) for support details +### EarthCODE Platforms Support +For these types of issues, the EarthCODE platform providers will directly support you. Please find the relevant types of issues, and their common solutions below. Refer to the [specific platform pages](../Technical%20Documentation/Platforms/) for additional details. \ No newline at end of file diff --git a/pages/Getting started with EarthCODE/index.md b/pages/Getting started with EarthCODE/index.md index 1f343ad0..7046dce3 100644 --- a/pages/Getting started with EarthCODE/index.md +++ b/pages/Getting started with EarthCODE/index.md @@ -54,7 +54,7 @@ There are two ways to explore EarthCODE: * [10 minutes to EarthCODE](./10%20minutes%20to%20EarthCODE.md) – A quick overview to get started fast * [Accessing EarthCODE](./Accessing%20EarthCODE.md) – Accessing EarthCODE and Platforms - * [Troubleshooting and Support](./Troubleshooting%20and%20Support.md) – Help when you need it + * [Frequently Asked Questions](./Frequently%20Asked%20Questions.md) – Help when you need it 3. **Explore the EarthCODE Platform Ecosystem** – We have a growing ecosystem of platforms to provide [FAIR and Open Earth Observation science tools and infrastructure](../Technical%20Documentation/Platforms/index.md) to explore. @@ -407,7 +407,7 @@ Once you’ve understood your role and the resources available, it's time to exp - Get in touch for onboarding support, fill in the short contact form at or e‑mail **earth-code@esa.int**. 3. **Troubleshooting** - If you hit a snag, check the [Common Issues & Solutions](./Troubleshooting%20and%20Support.md#common-issues-and-solutions) section first. + If you hit a snag, check the [Frequently Asked Questions](./Frequently%20Asked%20Questions.md) section first. Still stuck? Ask in the forum or drop us a line at the support address above.