search

EOEPCA / deployment-guide

EOEPCA Deployment Guide
https://deployment-guide.docs.eoepca.org/
Apache License 2.0
3 stars 7 forks source link

Add a "demo" section for deployment of applications #17

Open spinto opened 1 week ago

spinto commented 1 week ago

For the deployment of the BB, in the guide, in "Validation and Operation" you should have also a "demo" chapter, linking to the demo material (e.g., for pycsw, the demo pycsw notebook, for zoo, the zoo swagger UI, etc...)

james-hinton commented 1 week ago

I've expanded the 'Data Access' BB's validation section, Is this level of detail sufficient? If so, I’ll adjust the other BBs similarly. https://github.com/EOEPCA/deployment-guide/issues/19#issuecomment-2470875329

spinto commented 1 week ago

maybe too much, in the sense that we do not need all the info about how to start a notebook, just a link to the notebook and info on how to use it if required (e.g. maybe we need to remind that in the notebook the address of the endpoint needs to be set somethwere . So one line like:

The EOEPCA/demo Jupyter Notebooks showcase how to interact with the Data Access services programmatically, including examples for data discovery, visualisation and data download using the Data Access APIs. The notebooks specifically for the eoAPI and Stacture-based endpoints can be found here. Note that before running the notebook, you need to ensure sample data is registered into the Data Access component (follow [this guide]()) and that the data access API endpoint base_domain in the notebook reflects your endpoint.

If you want to keep how to start the notebook, ok, but in another page (as this is also generic for all the other components and we do not want to repeat it)...

james-hinton commented 1 week ago

Update data access documentation for Jupyter Notebooks and API testing - dc8fb618f7a82c87dbf1335cf0e4f65db504cda5

I got half way through writing a section about running Jupyter Notebooks, before thinking it makes more sense to just link to the existing EOEPCA/demo/README.md as that will be maintained along with its changes.