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

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

Open
spinto opened this issue Nov 11, 2024 · 3 comments
Open

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

spinto opened this issue Nov 11, 2024 · 3 comments
Assignees

Comments

@spinto
Copy link

spinto commented Nov 11, 2024

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
Copy link
Contributor

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. #19 (comment)

@spinto
Copy link
Author

spinto commented Nov 12, 2024

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 james-hinton self-assigned this Nov 13, 2024
@james-hinton
Copy link
Contributor

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

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.

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

When branches are created from issues, their pull requests are automatically linked.

2 participants