Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in / Register
  • M manual_and_guidelines
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • platform_manual_and_guidelines
  • manual_and_guidelines
  • Wiki
  • File types
  • Documentation

Last edited by Arne Dec 16, 2021
Page history

Documentation

Documentation of VIRTUAL content

As a fundamental requirement for the useability of the contents, a decent documentation of the project results has a high priority in Project VIRTUAL. Therefore, any Public content on the OpenVT platform must be documented in a way to make its application as straightforward as possible to external users!

Guidelines how to document your content:

  • The place for the documentation is in a dedacted folder on the repository. This makes sure that your documentation makes use of the full functionality and version control of Git.
  • Possible file formats: Markdown and Jupyiter notebooks.
  • Specify exactly the requirements of your content (e.g., necessary software or packages including versions thereof).
  • Apart from user manuals, also provide step by step instructions how to get started and examples working out-of-the-box
  • Specify how the users can reach you to give feedback and ask for support. The OpenVT platform provides an issue tracking board on each project for this purpose.
  • Encourage your collaborators and contributors to document their contributions in the same way.
  • As an example for how the documentation please check out the VIVA+ project
Clone repository
  • Contribute
  • FAQ and trouble shooting
  • General guideline for all file types
  • Getting started with Git
  • Installing Git: Linux
  • Installing git: Windows
  • Next steps with Git
  • Old vs. new OpenVT platform: How to update your local repositories
  • OpenVT Gitlab
  • Submodules
  • Subtrees
  • Upload guidelines
  • administration guidelines
  • file types
    • Data files
    • Documentation
View All Pages