|
|
### [Home](home)
|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
|
# Getting Started
|
|
|
|
|
|
## Where to Work
|
|
|
### For new Standards/Activities:
|
|
|
* Shared documents not relevant to deliverables (presentations, notes, minutes, papers, etc.) via Teams chat & shared files - i.e. things that do not need to be or cannot be versioned
|
|
|
* Anything that is relevant to deliverables (e.g. outlines, text etc.) -> Gitlab!
|
|
|
|
|
|
## 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)
|
|
|
|
|
|
[**Gitlab**](https://code.asam.net) / [**Github**](https://github.com/asam-ev)
|
|
|
: All source code and standard relevant documentation. Issues relevant to deliverables should be created here.
|
|
|
|
|
|
**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.
|
|
|
|
|
|
## ASAM Document Language & Formats
|
|
|
|
|
|
- All ASAM OpenX Standards are written using the Asciidoc format
|
|
|
|
|
|
- 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:**
|
|
|
|
|
|
- Openable in any text editor
|
|
|
- Focus on content not on formatting!
|
|
|
- Versionable and diffable – i.e. we can tell who did what, when and where!
|
|
|
|
|
|
|
|
|
>See the [AsciiDoc Guide](/docs/other-guides/Asciidoc-Guide) for a guide on writing Asciidoc.
|
|
|
---
|
|
|
### Git Workflow
|
|
|
- [Workflow Overview](/docs/git/Workflow)
|
|
|
---
|
|
|
### Project Guidelines
|
|
|
- [Where to Work](/docs/project_guidelines/Where-to-Work)
|
|
|
- [Project Communication Channels](/docs/project_guidelines/Project-Communication-Channels)
|
|
|
- [Document format](/docs/project_guidelines/ASAM-Document-Format)
|
|
|
- [Teams & Sharepoint](/docs/project_guidelines/Microsoft-Teams-and-Sharepoint)
|
|
|
- [Shared Project Calendar](/docs/project_guidelines/Shared-OpenX-Calendar)
|
|
|
- [ASAM Project Roles](/docs/project_guidelines/ASAM-Project-Roles)
|
|
|
- [ASAM DCO for Open Source Projects](/docs/project_guidelines/ASAM-DCO)
|
|
|
- [ASAM Quality Guidelines](/docs/project_guidelines/Quality-Guidelines)
|
|
|
## First Time Setup
|
|
|
See the [setup guide](/docs/project_guidelines/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](/docs/project_guidelines/Microsoft-Teams-and-Sharepoint) for information on getting setup with Microsoft Teams.
|
|
|
|
|
|
Finally, [synchronise with the OpenX calendar](/docs/project_guidelines/Shared-OpenX-Calendar), a shared calendar across all ASAM OpenX projects that lists all meetings taking place.
|
|
|
|
|
|
---
|
|
|
### [First Time Setup](/docs/project_guidelines/Setup-Guide)
|
|
|
|
|
|
## Repository Workflow
|
|
|
See the [Workflow Overview](/docs/git/Workflow) 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](/docs/git/ASAM-Issue-and-MR-Labels)
|
|
|
|
|
|
---
|
|
|
|
|
|
### General Git Guidelines
|
|
|
- [Available Issue and MR Labels](/docs/git/ASAM-Issue-and-MR-Labels)
|
|
|
- [Commit message guidelines](/docs/git/Commit-Guidelines)
|
|
|
### Further Repository Guidelines
|
|
|
- [Commit message guidelines](/docs/git/Commit-Guidelines) - Formatting guidelines for commit messages on commits/merges to the ASAM master branches
|
|
|
- [Git](/docs/git/An-Introduction-to-Git)
|
|
|
- [Resolving merge conflicts](/docs/git/Resolving-Merge-Conflicts)
|
|
|
- [Branching](/docs/git/Branching)
|
|
|
- [Forking](/docs/git/Forking)
|
|
|
|
|
|
|
|
|
---
|
|
|
### Other Guides
|
|
|
- [VSCode](/docs/other-guides/VSCode-Guide)
|
... | ... | @@ -31,4 +71,3 @@ |
|
|
|
|
|
---
|
|
|
|
|
|
- [Sidebar](_sidebar) |