OOD docs updates and restructuring

CSCfi / csc-user-guide

User guides, FAQs and tutorials related to CSC services

https://docs.csc.fi

Creative Commons Attribution 4.0 International

46 stars 80 forks source link

OOD docs updates and restructuring #2039

Closed rkronberg closed 3 months ago

rkronberg commented 5 months ago

Proposed changes

Updates to Web Interface documentation. Restructure and clarify index page. Improve Allas usage documentation.

https://csc-guide-preview.rahtiapp.fi/origin/ood-docs-update/

Checklist before requesting a review

[x] I have followed the instructions in the Contributing and Styleguide documents.
[x] My pull request passes all tests.
[x] I have included a link to the appropriate preview page (select your branch from the list).

rkronberg commented 3 months ago

I think this PR is ready for review. We did not edit the individual apps-pages yet, let's do improvements there in a separate PR (e.g. improve Jupyter instructions).

robinkar commented 3 months ago

It might be good to have some additional instructions for when the interactive apps fail to launch. Right now we mention "launch the app again", but it might be good to have some instructions beyond that, maybe on the "Interactive Apps" page. Common failures could be Lustre issues, job ran out of memory, invalid form options (invalid Python installation for Jupyter), etc.

rkronberg commented 3 months ago

Good point. I'll add a subsection "Troubleshooting" on the "Interactive Apps" page.