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 Documentation module #104

Merged
merged 17 commits into from
Aug 7, 2024
Merged

Add Documentation module #104

merged 17 commits into from
Aug 7, 2024

Conversation

raar1
Copy link
Collaborator

@raar1 raar1 commented Aug 7, 2024

This follows on from the work in PR #31 by:

  • Rebasing onto main (the branch was very old and incompatible with the newer versions of NEBULA)
  • Adding metadata for the module, including a thumbnail from unsplash (unsplash licensed)
  • Adding metadata for the slides and exercises, fixing ordering etc
  • Adding learning objectives in info.md
  • Moving introduction content to a "Further reading" tab, since it was mostly headings and links. We can add an intro back again later if desired

Fixes #7

@raar1
Copy link
Collaborator Author

raar1 commented Aug 7, 2024

OK, I have now added quite a few extra slides from https://esciencecenter-digital-skills.github.io/digital-skills-slides/ regarding documentation because I think they are quite nice and fit here.

Regarding Sven's remark about the need for an introduction, we can still provide one but IMO the slide deck is now essentially a suitable intro to the module and I've placed it first.

I removed the RS-DAT and Xenon examples that Jaro took exception to (I agreed).

This module can certainly benefit from some polishing, additions etc but I think that it is time to merge this as the first version of the Documentation module so that instructors can start preparing. For any further improvements I propose that we open specific issues to handle these. What do you think @JaroCamphuijsen ?

Copy link
Collaborator

@JaroCamphuijsen JaroCamphuijsen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really good. Thank you @svenvanderburg @paulmaxus @raar1 @meronvermaas @c-martinez

@raar1 raar1 merged commit 0d07e43 into main Aug 7, 2024
1 check passed
@raar1 raar1 deleted the documentation-module branch August 7, 2024 15:31
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

Successfully merging this pull request may close these issues.

Software documentation module
6 participants