User Tools

Site Tools


oscae:guide:contributions_tips

(Preliminary) Guide on contributions to the wiki

[draft] Preliminary guide on contributions to the wiki

  1. Content: Although ideal, copying excellent external content (from the internet in general, or contributors' own websites) may not be necessary. Links to relevant external content (or indicate which contents are obsolete) can already be good enough. Consider writing some 'wrapper' (simplifications, summary, and/or comments) regarding the external links.
  2. Prioritise on adding content (pages/files) so that it can be published and shared as quickly as possible. Organisation of the content and the appearance can be incrementally implemented as an afterthought. The used wiki framework (Dokuwiki) automatically adapts the internal links when the contents (pages/files) internal to the wiki are relocated/renamed, therefore avoid broken links due to the reorganisation/renaming operations. Expect that some content (tips, workarounds, specifics to software version, …) can quickly become obsolete and need updates before they can become 'fully complete'.
  3. Link as much as possible towards existing internal pages/files when applicable. Several topics may make reference to the same existing content. Non-linear and circular references are common.
  4. Due to limited storage size on the temporary and possible issues with copyrighted materials, file upload should be avoided for now. It is encouraged to provide links to cloud file/video hosting. Google Drive, Dropbox, and mega.nz, for example, are suitable for the hosting and linking general files, where the generated links are permanent 1). Videos can be stored as unlisted Youtube videos (accessible only via URL).
  5. Other aspects? Please let us know additional aspects to consider in the discussion section below or by other means. Many more will become clear, which highly dependent on how the wiki grows.
1)
although renamed and relocated within the hosting space

Discussion

Enter your comment. Wiki syntax is allowed:
 

This topic does not exist yet

You've followed a link to a topic that doesn't exist yet. If permissions allow, you may create it by clicking on Create this page.

oscae/guide/contributions_tips.txt · Last modified: 2022/03/25 18:15 by hazmilazis