Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

AsciiDoc based user documentation #17

Open
andreaskern74 opened this issue Feb 29, 2024 · 1 comment
Open

AsciiDoc based user documentation #17

andreaskern74 opened this issue Feb 29, 2024 · 1 comment
Labels
effort:Unclear isState:Accepted An issue that has been accepted by the group, which needs to be assigned to a responsible isType:Feature An issue that adds new features to the project.
Milestone
Wish List

Comments

@andreaskern74
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

Currently, the user documentation is written in Markdown, which is fast to maintain, but strongly limited regarding layout and cross-referencing.

All other current ASAM projects using AsciiDoc based on a common guide. This leads to a harmonized view of all documents and a harmonized styling. And it resolves all limitations from Markdown.

Describe the solution you'd like

  • Translate current user manual/documentation in AsciiDoc
  • Development documentation of the framework itself should not be translated, because these files need to be easily accessible/readable in the repository
  • Use ASAM style templates
  • Setup the generation of the documentation in the CI

See ASAM Editorial Guide and other ASAM projects as reference.
@andreaskern74 andreaskern74 added isType:Feature An issue that adds new features to the project. isState:New A new issue that needs to be classified to a type. labels Feb 29, 2024
@andreaskern74 andreaskern74 added isState:Accepted An issue that has been accepted by the group, which needs to be assigned to a responsible and removed isState:New A new issue that needs to be classified to a type. labels Mar 28, 2024
@hoangtungdinh hoangtungdinh moved this to Sprint Todo in Quality Checker Jul 30, 2024
@andreaskern74 andreaskern74 added the isState:ForCCBReview CCB will review it and change the status to ReadyForMerge if everything is ok label Aug 1, 2024
@andreaskern74
Copy link
Collaborator Author

After the hackathon, we probably need to reject that --> CCB.

@andreaskern74 andreaskern74 added this to the Wish List milestone Aug 22, 2024
@andreaskern74 andreaskern74 removed the isState:ForCCBReview CCB will review it and change the status to ReadyForMerge if everything is ok label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
effort:Unclear isState:Accepted An issue that has been accepted by the group, which needs to be assigned to a responsible isType:Feature An issue that adds new features to the project.
Projects
Quality Checker
Status: No status
Milestone
Wish List
Development

No branches or pull requests
1 participant
@andreaskern74