sdc issueshttps://gitlab.leibniz-kis.de/groups/sdc/-/issues2022-04-27T10:55:09Zhttps://gitlab.leibniz-kis.de/sdc/kis_tools/-/issues/309Better Error messages for failure due to untranslated data2022-04-27T10:55:09ZCarl SchafferBetter Error messages for failure due to untranslated dataBoth `gris_location_plot` and `gris_gen_maps` fail when pointed at untranslated data. Te error messages do not list this as the cuse, should be improved.Both `gris_location_plot` and `gris_gen_maps` fail when pointed at untranslated data. Te error messages do not list this as the cuse, should be improved.https://gitlab.leibniz-kis.de/sdc/gris/cassda_gui/-/issues/2write setup instructions2022-03-15T08:23:43ZCarl Schafferwrite setup instructionshttps://gitlab.leibniz-kis.de/sdc/gris/grisview/-/issues/12Readme: Add example of data2021-07-07T11:26:58ZCarl SchafferReadme: Add example of dataIn addition to the current readme, it would be nice to have an example dataset included. E.g. pull a sample dataset from the website and open that in grisviewer.
Or alternatively, put a sample folder on the KIS network, make it publica...In addition to the current readme, it would be nice to have an example dataset included. E.g. pull a sample dataset from the website and open that in grisviewer.
Or alternatively, put a sample folder on the KIS network, make it publically available and list it as a sample.grisview-releasehttps://gitlab.leibniz-kis.de/sdc/kis_tools/-/issues/281document slit angle calculation in docstrings and comments2021-05-04T07:01:02ZCarl Schafferdocument slit angle calculation in docstrings and commentsDouble check the in-code documentation with the angle code, seems outdatedDouble check the in-code documentation with the angle code, seems outdatedhttps://gitlab.leibniz-kis.de/sdc/gris/grisview/-/issues/2Add Documentation2021-04-13T11:57:54ZCarl SchafferAdd DocumentationDocumentation needs to be added to the tool:
* [ ] installing
* [ ] getting started/running on a sample dataset (sample dataset using sdc as a data source (download data from web, extract, run grisviewer)
* [ ] overview of features
* [ ]...Documentation needs to be added to the tool:
* [ ] installing
* [ ] getting started/running on a sample dataset (sample dataset using sdc as a data source (download data from web, extract, run grisviewer)
* [ ] overview of features
* [ ] which requirements are there for data (e.g. l1 translated data)
Places where the documentation needs to be referenced:
* [ ] readme.md
* [ ] Entry to code overview page on confluence[here](https://leibniz-kis.atlassian.net/l/c/omh0EXD0)
* [ ] Short info/landing page as a child for documentation in the [manuals page](https://leibniz-kis.atlassian.net/l/c/p2aAmANN)
Do you want to use gitlab pages and readthedocs for documentation? This probably spawns a lot of smaller sub-issues, @guenter has a proof of concept to use gitlab pages and runners to automatically build and deploy the documentation. It might be more suited to technical/developer documentation, but definitely best practice.
* [ ] evaluate and plan readthedocs and gitlab pages strategygrisview-releasehttps://gitlab.leibniz-kis.de/sdc/kis_tools/-/issues/251gitlab pages documentation2020-10-23T07:30:20ZCarl Schaffergitlab pages documentationAdd automatically built documentation.
CI Setup and basic functionality is contained in the [docs branch](https://gitlab.leibniz-kis.de/sdc/kis_tools/-/tree/docs)
Things to take care of:
* [ ] think a bout strategy when the push shoul...Add automatically built documentation.
CI Setup and basic functionality is contained in the [docs branch](https://gitlab.leibniz-kis.de/sdc/kis_tools/-/tree/docs)
Things to take care of:
* [ ] think a bout strategy when the push should ocurr and when the documentation should be built (`only` section in gitlab ci)
* [ ] use common format for docstrings, check using tool
* [ ] Add structure in `.rst`files