check available documentation
Closed this issue · 6 comments
Check which documentation is available, update outdated information and document problems or incomprehensive parts where found.
Available documentation I found so far:
actinia website: https://actinia.mundialis.de/
- examples: calculate NDVI and LST (https://actinia.mundialis.de/)
- actinia tutorial: https://actinia.mundialis.de/tutorial/index.html
- actinia workshop: A gentle introduction to actinia: https://neteler.gitlab.io/actinia-introduction/
API docs:
- full API documentation: https://actinia.mundialis.de/api_docs/
- JSON definition of the API: https://actinia.mundialis.de/latest/swagger.json
- https://redocly.github.io/redoc/?url=https://actinia.mundialis.de/latest/swagger.json
actinia_core/docs/docs
- actinia_concepts.md
- index.md
- installation.md
- introduction.md
- various tutorials
further mentioned in #181
- user docs
- docstring
Please feel free to add missing pieces of documentation, so that we get a full overview of what documentation is there
!!! SOLVED in PR #258 !!!
There is a problem with on example in the tutorial 'docs/docs/tutorial_data_access.md'. Listing all strds in ECAD PERMANENT fails:
15:11 $ curl ${AUTH} -X GET -i "${ACTINIA_URL}/v1/locations/ECAD/mapsets/PERMANENT/strds"
HTTP/1.1 404 NOT FOUND
Server: nginx/1.18.0 (Ubuntu)
Date: Fri, 28 May 2021 13:12:06 GMT
Content-Type: text/html; charset=utf-8
Content-Length: 232
Connection: keep-alive
Access-Control-Allow-Origin: *
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<title>404 Not Found</title>
<h1>Not Found</h1>
<p>The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.</p>
Another issue in the NDVI example on the actinia website (https://actinia.mundialis.de/):
In the second step "polling the status URL it, until the status is 'finished':" does not work:
10:38 $ curl -u 'demouser:gu3st!pa55w0rd' \
> -X GET \
> 'https://actinia.mundialis.de/api/v1/resources/demouser/resource_id-87c6ddf2-0911-4e16-95eb-a4ea466f18ac'
{"message":"Resource does not exist","status":"error"}
TODO: write available documentation list in Wiki
I added the missing pieces of documentation to the Wiki, mainly Redoc API documentation and actinia introduction and tutorial from actinia landing page.