Each tutorial is in a directory, optimally with strings indicating:
- topical area (e.g.
surf) - body (e.g.
mars) - experiment(s) (e.g.
HRSC)
Available prefixes include:
- sshd (sshade) - for Task3: sshade
- surf (surfaces) - for Task4: surfaces
- magn (magnetospheres) - for Task5: magnetospheres
- smbd (small bodies) - for Task6: small bodies
- atmo (atmospheres) - for Task 7: atmospheres
- exop (explanets) - for Task 8: exoplanets
- misc (miscelaneous) - for content that doesn't particularly fit the above categories
examples tutorial names:
- surf_mars_crism
- magn_saturn_cassini
- surf_moon_craters
- atmo_titan_vims
The directory name of each tutorial should be easy, self-explanatotory and without space, e.g. cassini-titan-flyby
Please follow the template on template and use simple, meaningful image names without spaces in the filename.
A sample formatted tutorial based on the existing one on the VESPA wiki
Once a tutorial exists, can be updated either directly (if added to the right team, please get in touch with @arosp. Or, you could fork the repository, make your changes and create a pull request. The procedure is described in several tutorials on the internet, e.g. GitHub's creating a pull request from a fork.
Images embedded in a tutorial should be in the [img][template/img] subdirectory of each tutorial.
- Images should be embedde with meaningful, short names and no spaces in the filename. Format preferably PNG or JPEG.
- If too big (larger than ~400 px) please resize embedding the full path ("download", not url of location in repo), i.e.
<img src="https://raw.githubusercontent.com/epn-vespa/tutorials/master/template/img/1.png" width="400">- In any case, please keep image/screenshot file size reasonably small.
- Videos can be linked from YouTube/Vimeo or similar video streaming, preferably with a placeholder screenshot, e.g. as described here.
- the working copy of each tutorial is on the VESPA Tutorial repository. The README.md of each is linked on the VESPA wiki and the level of maturity (draft, final, updated, etc.) is indicated in both the Changes log (e.g. change log on the sample tutorial) and on the wiki.