Checklist for GitPages release

[socadk]

• Caution: READMEs require separate treatment w.r.t links
  • add manually
  • remove relative links to repo sources under "More information"
• Copy top-level files, tutorials, artifacts, activities, roles, bibliography
• Move repo README to introduction.md (and folder-level ones need to be renamed too)
  • (in top-level folder) rm introduction.md and then mv README.md introduction.md
• Link to GitPages Home
  • (in activities folder) sed -i '9 i [Git Pages Home](https://socadk.github.io/design-practice-repository)' *.md and sed -i '10 i [Activities Overview](https://socadk.github.io/design-practice-repository/activities)' *.md and (optional) sed -i '9 i \\' *.md
  • (in artifact-templates folder) sed -i '8 i [Git Pages Home](https://socadk.github.io/design-practice-repository)' *.md and sed -i '9 i [Artifacts Overview](https://socadk.github.io/design-practice-repository/artifact-templates)' *.md and (optional) sed -i '8 i \\' *.md
  • (in roles folder) sed -i '5 i [Git Pages Home](https://socadk.github.io/design-practice-repository)' *.md and sed -i '6 i [Roles Overview](https://socadk.github.io/design-practice-repository/roles)' *.md and (optional) sed -i '5 i \\' *.md
• Check figures, adjust links:
  • (in activities folder) sed -i 's@/activities/@./@g' *.md
  • (in artifact-templates folder) sed -i 's@/artifact-templates/@./@g' *.md
  • Not needed yet: (in roles folder) sed -i 's@/roles/@./@g' *.md

[socadk]

Something to be aware of: (from https://leanpub.com/markua/read#leanpub-auto-newlines)

In Markdown, to output a forced line break (a <br/> tag in HTML), you need to add two spaces at the end of the line, followed by a single newline. This means that it is impossible to look at a Markdown document with single newlines in it and understand what they mean: you need to find out if there are invisible formatting characters at the end of the line to find out if the newlines mean “newline” or “single space”.

[koppor]

In case it helps: The other alternative to create newlines in Markdown is to use \:

First line\
second line.

Rendered output:

First line\ second line.

[socadk]

Scripted now, some manual postprocessing might be needed (depending on build steps, full vs. incremental)

• Add links to readmes in index pages
• Add links to Home etc. in readmes
• Add links in bibliography page (literature.md)
• Remove pointers to background information folders in readmes

[socadk]

• Check that comments are respected, for instance after "Hints" bullet list in CEL