Skip to content

GitLab

W
wiki

Simulation Wiki now available - includes a first sketch of workflow and project guidelines. Get in touch if you have any feedback!
https://code.asam.net/simulation/wiki/-/wikis/home

Home

Last edited by Katharina Loehberg
Page history

Overview

Communication Channels

Microsoft Teams : Chat, conferencing, document folder for sharing documents (e.g. research papers, notes, videos, anything that does not need to be versioned) - See the Teams Guide

Gitlab : All source code and standard relevant documentation. Issues relevant to deliverables should be created here. See Workflow Overview

Github : ADD

Mailing list : Project level communication will be duplicated here from the teams channel for redundancy (e.g. project meetings, announcements)

OpenXCalendar : Subscribable, shared calendar for all OpenX projects - this lists (filterable) all meetings for each project. See OpenX Calendar

Setting up a Meeting

Meeting Guidelines

ASAM Document Language & Formats

  • All ASAM OpenX Standards are written using the Asciidoc format asciidoc Homepage

  • AsciiDoc is a mature, plain-text writing format for authoring notes, articles, documentation, books, ebooks, web pages, slide decks, blog posts, man pages and more.

  • AsciiDoc belongs to the family of lightweight markup languages, the most renowned of which is Markdown. 

You write an AsciiDoc document the same way you would write a normal text document. There are no markup tags or weird format notations. AsciiDoc files are designed to be viewed, edited and printed directly or translated to other presentation formats.

Main advantages:

  • Can be edited in any text editor or using the online editor in Gitlab
  • Focus on content not on formatting!
  • Versionable and diffable – i.e. we can tell who did what, when and where!
  • In the end we can deliver an interactive html instead of a static pdf

See the AsciiDoc Guide for a guide on writing Asciidoc.

Further Project Guidelines

Project Guidelines

Getting Started

First Time Tool Setup

See the setup guide for a step-by-step on installing the tools we recommend for interacting with ASAM standards and repositories.

Additionally, see the guide to Teams & Sharepoint for information on getting setup with Microsoft Teams.

Finally, synchronise with the OpenX calendar, a shared calendar across all ASAM OpenX projects that lists all meetings taking place.

Further Guides

Repository Workflow

See the Workflow Overview for a walkthrough on how to work on actively developing the ASAM standards.

For a list of available labels in ASAM repositories, see this overview of labels

Further Repository Guidelines