updating docs with additional content

santilland · santilland · commit a62f54f869c1 · 2024-06-18T18:18:46.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 .vitepress/dist
 .vitepress/cachenode_modules/
+.vitepress/cache
+node_modules
diff --git a/.vitepress/config.mjs b/.vitepress/config.mjs
@@ -11,16 +11,18 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Introduction', link: '/welcome' }
+      { text: 'Welcome', link: '/welcome' }
     ],
 
     sidebar: [
       {
         text: 'Introduction',
         items: [
-          { text: 'Welcome', link: '/welcome' },
           { text: 'Preamble', link: '/preamble' },
+          { text: 'Welcome', link: '/welcome' },
           { text: 'Components', link: '/components' },
+          { text: 'Roadmap', link: '/roadmap' },
+          { text: 'Technology', link: '/technology' },
         ]
       },
       {
@@ -35,8 +37,8 @@ export default defineConfig({
         text: 'Content',
         items: [
           { text: 'Content integration', link: '/content' },
-          { text: 'Data', link: '/data' },
-          { text: 'Stories', link: '/stories' },
+          { text: 'Data configuration', link: '/data' },
+          { text: 'Storytelling', link: '/storytelling' },
         ]
       }
     ],
diff --git a/assets/eodash_ecosystem.png b/assets/eodash_ecosystem.png
diff --git a/catalog.md b/catalog.md
@@ -1,3 +1,11 @@
 # Catalog backend
 
-This section is still needs to be filled! Please come by soon again, it is being worked on! 
+Let's start with the [catalog-template](https://github.com/eodash/catalog-template), navigate there and click on the "Use this template" button on the top right to create a new repository instance controlled by you. Once your instance is created follow the [How-to](https://github.com/eodash/catalog-template?tab=readme-ov-file#how-to) to enable github pages to automatically generate and host your catalog.
+
+A very basic catalog example with one collection is already setup, so you can make sure your instance is correctly configured by going to `https://<organization>.github.io/<repository>/<catalog_name>/catalog.json`
+
+To further understand configuration options for data collections have a look at the [data configuration](./data) section. 
+
+The generation of the catalog which the catalog-template utilizes is based on the [eodash_catalog](https://github.com/eodash/eodash_catalog) python package. For further information please have a look at the repository and documentation.
+
+Please have a look at how to setup an eodash instance in the next section [eodash instance](./eodash).
diff --git a/data.md b/data.md
@@ -1,3 +1,3 @@
-# Data
+# Data configuration
 
 This section is still needs to be filled! Please come by soon again, it is being worked on! 
diff --git a/eodash.md b/eodash.md
@@ -1,3 +1,19 @@
-# eodash
+# eodash instance
 
-This section is still needs to be filled! Please come by soon again, it is being worked on! 
+If you have already a catalog endpoint set up (if not see [Catalog backend](./catalog)) you can create an eodash instance to point to it.
+
+We have created to example template repositories showcasing the two possible approaches of integrating eodash, this is either:
+*  as a [web component](https://developer.mozilla.org/en-US/docs/Web/API/Web_components) in the [eodash-pages-template](https://github.com/eodash/eodash-pages-template) 
+* or as an vite based application for supporting further development of custom widgets in the [eodash-instance-template](https://github.com/eodash/eodash-instance-template). 
+
+Both examples have their own application areas, so please feel free to explore both. As example here let's say you would potentially like to extend the core capabilities available, so using the eodash-instance-template could be a good candidate.
+
+Visit the [eodash-instance-template](https://github.com/eodash/eodash-instance-template) and use the "Use this template" button at the top right to create your own repository.
+
+The only change that in principle needs to be made is to point the instance to your catalog endpoint. The configuration file is under `/src/main.js`. There in the `stacEndpoint`setting add your endpoint and commit the changes to your repository. [This](https://github.com/eodash/eodash-instance-template/blob/main/src/main.js#L8) is the location in the example instance repository. If you followed the previous section for setting up your catalog your url should look something like this: `https://<organization>.github.io/<repository>/<catalog_name>/catalog.json`.
+
+Once this change is done make sure that github pages are activated for the repository and pointing to the gh-pages branch. For example the instance template is deployed the same way and can be reached through https://eodash.github.io/eodash-instance-template/
+
+For your project you should be able to find the url in the deployment section of your github repository and should look like: `https://<organization>.github.io/<repository>`
+
+The same approach can be used for the other template repository. The [eodash-pages-template](https://github.com/eodash/eodash-pages-template) uses [vitepress](https://vitepress.dev/) as framework in which the eodash web component variant is integrated. It also shows how to additionaly be able to create static pages, as well as integrate the [storytelling](./storytelling) concept all under one static deployment.
diff --git a/first_steps.md b/first_steps.md
@@ -1,7 +1,12 @@
 # First steps
 
-The main idea of the eodash ecosystem is to allow any number of setups, such as only using individual components might be used, integration of specific endpoints or dynamically configured clients based on some specialized user workspaces.
+The main idea of the eodash ecosystem is to allow any number of setups, such as only using individual components, integration of specific endpoints or dynamically configured clients based on some specialized user workspaces.
 
-Here we want to show some examples setups that should hopefully get you started with just some clicks.
+We still want to make sure that setting up the ecosystem can be easily managed by anyone. We have create some template repositories to help you achieve this.
+These template repositories showcase integration into other frameworks giving you an idea of how you could introduce them into your own architecture.
 
-More content coming soon!
+We want to present basic use cases in a way that they can be used by themselves as well as to introduce you to how aspects of the ecosystem could be integrated into a service you manage.
+
+As described in eodash ecosystem [concept](./welcome#concept) we need only two things for an eodash instance, a supported (STAC) catalog and a configured and deployed eodash instance.
+
+We can achieve this by utilizing github pages capabilities. This is how the template repositories are set up, have a look at the [Catalog backend](./catalog) section to learn how to setup your own catalog deployment. Afterwards look into the [eodash instance](./eodash) section to learn how to deploy and configure your own instance.
diff --git a/roadmap.md b/roadmap.md
@@ -0,0 +1,36 @@
+# Roadmap
+
+This project tries to bring together experience and capabilities gathered working in Earth Observation related field.
+This will be an iterative process which will also be influenced by potential community interactions.
+
+We are grateful for inputs and thoughts in form of issues in respective components.
+If you are unsure where to create an issue feel free to use the [eodash issue board](https://github.com/eodash/eodash/issues).
+
+We want to note some roadmap steps that are potentially on the horizon to help stimulate discussion.
+
+* eodash
+    - extend support for generic STAC catalogs
+    - create eodash STAC catalog extension
+    - increase number of example (template) repositories for other frameworks
+    - implement support of flat styles for serverless datasets (COG and GeoJSON)
+    - look into supporting cloud optimized vector formats
+    - implement chart rendering of data based on [VEGA chart definition language](https://vega.github.io/vega/)
+    - describe how to implement a custom widget (as part of eodash instance template)
+* catalog
+    - plugin system
+    - improvement on performance for very large collections
+    - potential switch to another base library
+* storytelling
+    - allow importing map state based on passed STAC item (and state modifiers)
+    - allow importing of chart state based on passed STAC item (and state modifiers)
+    - integrate VEGA chart definition rendering component
+    - improve documentation
+* documentation
+    - extend description of usage and examples
+    - add links to open example instances
+* others
+    - initialize process of becoming a OSGeo Community Project
+    - create library or helper UI to more easily create flat styles (extended by eox-forms)
+    - implement (or wrap) VEGA chart definition rendering component
+
+
diff --git a/storytelling.md b/storytelling.md
@@ -1,3 +1,3 @@
-# Stories
+# Storytelling
 
 This section is still needs to be filled! Please come by soon again, it is being worked on! 
diff --git a/technology.md b/technology.md
@@ -0,0 +1,9 @@
+# Technology
+
+eodash is intended as frame and component communicator for core and third party widgets.
+
+The core widgets are based around [EOxElements](https://eox-a.github.io/EOxElements/) and extended by how they interact with each other. 
+
+The state management within eodash is based around [SpatioTemporal Asset Catalogs (STAC)](https://stacspec.org), each component can register to a central store, supported by [pinia](https://pinia.vuejs.org/).
+
+The eodash framework is based on [vue.js](https://vuejs.org/) 
diff --git a/welcome.md b/welcome.md
@@ -4,15 +4,32 @@ Great to see you are interested in learning more about the eodash ecosystem!
 
 Firstly a quick note: the components do not have a stable release and the documentation is also being worked on, so updates and changes are very much to be expected!
 
-With this documentation we want to cater two user groups:
-  - System administrators looking into how to setup or integrate the eodash ecosystem into their environments, providing an extended service to other users
-  - Members of a community and users of an extended service suite where the eodash ecosystem has been integrated to understand how to integrate their data and results
+## Goal
+With this ecosystem we want to provide an easily usable, configurable and extendable toolset to present results and achievements around the earth observation domain online and accessible.
+
+We want to establish this ecosystem by collaborating with the different EO communities and understanding their requirements, trying to set it up as a more open community project to foster communication.
+
+The core functionality of the toolset should cater to provide a baseline that can be used by each of these communities but still allowing to easily integrate their unique solutions.
+
+The documentation tries to cater two user groups:
+  - Service administrators looking into how to setup or integrate the eodash ecosystem into their environments, providing an extended service to other users
+  - Members of a community and users of an extended service suite where the eodash ecosystem has been integrated to provide information on how to integrate their data and results
 
 ## What is the eodash ecosystem?
 
-The eodash ecosystem is an aggregation of tools provided in a permissive license conceptualized around STAC that work well together and in a federated way to provide the basis to integrate Earth Observation data into an overarching service package.
+The eodash ecosystem is an aggregation of tools provided in a permissive license conceptualized around [SpatioTemporal Asset Catalogs (STAC)](https://stacspec.org) that work well together and in a federated way to provide the basis to integrate Earth Observation data into an overarching service package.
 The main tools are a web client dashboard library (eodash) as well as a catalog generator library that provide the basis for integration of many types of endpoints.
 
 ## Concept
 
 ![architecture concept figure](./assets/eodash_ecosystem.png)
+
+The figure above shows the main components of the eodash ecosystem, as well as how they interact with each other.
+
+The **eodash [catalog](https://github.com/eodash/eodash_catalog)** is a helper python package which supports a series of commonly used serverless EO data endpoints as well as service endpoints, such as [OGC](https://www.ogc.org/) services, [ViewServer](https://gitlab.eox.at/vs), STAC catalogs, and others.
+By defining a collection configuration file an end user can provide a wide range of visualization and analysis definitions to describe how the data should be visualized on the eodash web client. The supported resources are described [here](https://github.com/eurodatacube/eodash-catalog/wiki/Resource). The output of the catalog helper package is a static catalog (series of files), that can be hosted on any web server.
+
+The generated static catalog is the input used by an **[eodash](https://eodash.github.io/eodash/)** instance to populate the information shown. This includes descriptive text, assets, analysis functions and most importantly customizable EO data visualization through a series of configurable widgets. eodash provides a set of **core widgets** that can be configured to navigate and interact with the data. Third party widgets can be developed and integrated through the configuration by (for example) reacting to specific **STAC extensions** in the catalog.
+
+For wider audiences the [storytelling](https://eox-a.github.io/EOxElements/?path=/docs/elements-eox-storytelling--docs) component is envisioned. It provides an online editor (based on [Markdown](https://www.markdownguide.org/)) to create an interactive and guided experience. Results and datasets shown in eodash instances can be easily integrated. Field experts and communicators are able to create such content by utilizing the capabilities provided by eodash.
+

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-# Data`
	`1`	`+# Data configuration`
`2`	`2`
`3`	`3`	`This section is still needs to be filled! Please come by soon again, it is being worked on!`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-# Stories`
	`1`	`+# Storytelling`
`2`	`2`
`3`	`3`	`This section is still needs to be filled! Please come by soon again, it is being worked on!`