Skip to content

Conversation

@PhRosenberger
Copy link
Contributor

@PhRosenberger PhRosenberger commented Jan 19, 2022

Reference to a related issue in the repository

Should solve #47

Add a description

We should help building and contributing to the documentation by adding build instructions to the README.

Mention a member

@stefancyliax and @LukasElster what do you think on my proposed changes?

Check the checklist

  • I have performed a self-review of my own code/documentation.
  • My documentation changes are related to another repository in the organization. Here is the link to the issue/repo.
  • My changes generate no new warnings during the documentation generation.
  • The existing travis ci which pushes the documentation to gh-pages passes with my changes.

@PhRosenberger PhRosenberger self-assigned this Jan 19, 2022
@PhRosenberger PhRosenberger linked an issue Jan 19, 2022 that may be closed by this pull request
@PhRosenberger PhRosenberger added documentation Everything which impacts the quality of the documentation and guidelines. suggestions I just want to drop by and leave this suggestion to think about. labels Jan 19, 2022
also migrated the README to asciidoc as other documentation

Signed-off-by: Stefan Cyliax <stefan.cyliax@asam.net>
@stefancyliax
Copy link
Collaborator

@PhRosenberger Rewrote the instructions and the whole README. Please review.

@PhRosenberger
Copy link
Contributor Author

@stefancyliax Instructions seem fine for me.

However, I am wondering the README here shouldn't be somehow included in the Docu itself as e.g.

  • 4.5 Contributing to the OSI Documentation
    • 4.5.1 Building the Docu Locally
    • 4.5.2 Don't hesitate, there is a review process anyways

@stefancyliax
Copy link
Collaborator

However, I am wondering the README here shouldn't be somehow included in the Docu itself as e.g.

  • 4.5 Contributing to the OSI Documentation

    • 4.5.1 Building the Docu Locally
    • 4.5.2 Don't hesitate, there is a review process anyways

I'll create an issue for this. We are currently writing a central ASAM guide, that describes our working model and doc-as-code approach. I'm unsure if this should be describe there or be a part of the OSI documentation.

@PhRosenberger
Copy link
Contributor Author

However, I am wondering the README here shouldn't be somehow included in the Docu itself as e.g.

  • 4.5 Contributing to the OSI Documentation

    • 4.5.1 Building the Docu Locally
    • 4.5.2 Don't hesitate, there is a review process anyways

I'll create an issue for this. We are currently writing a central ASAM guide, that describes our working model and doc-as-code approach. I'm unsure if this should be describe there or be a part of the OSI documentation.

Ok yes, good idea to take this into a new issue.

Then I would support to give this one into next CCB meeting.

@stefancyliax stefancyliax merged commit 51dfe71 into master Apr 14, 2022
@stefancyliax stefancyliax deleted the feature/add_docu_build_instructions branch April 14, 2022 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything which impacts the quality of the documentation and guidelines. suggestions I just want to drop by and leave this suggestion to think about.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add manual on how to add to asciidoc documentation

3 participants