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.

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

Add some user and tech doc #3

Merged
merged 3 commits into from
Jun 23, 2020
Merged

Add some user and tech doc #3

merged 3 commits into from
Jun 23, 2020

Conversation

vgramer
Copy link
Member

@vgramer vgramer commented Jun 16, 2020

it's not complete but it's a beginning

user documentation

  • Idea products compatibility
  • Opa version compatibility
  • Faq (test duration and pass test )
  • how to create new rego file and edit the template used for creation
  • how to change highlighting color
  • comment code

tech doc

add user and tech documentation

@vgramer vgramer self-assigned this Jun 16, 2020
@vgramer vgramer added the documentation Improvements or additions to documentation label Jun 16, 2020
Also:
- move go license to docs/devel
- add opa version requirement
- correct some english mistake

the documentation is not complete, but it's a beginning

Signed-off-by: Vincent Gramer <[email protected]>
@vgramer vgramer marked this pull request as ready for review June 18, 2020 16:10
Copy link
Member

@asadali asadali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overall looks really good with the explanatory notes! 👍
The changes are really nitpicky that I kept making as I read the PR.

@vgramer
Copy link
Member Author

vgramer commented Jun 19, 2020

@asadali thanks a lot for the review !

Copy link

@lkadalski lkadalski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comments/questions. Overall ok, I'm not an expert in writing doc 😄

@vgramer vgramer merged commit 935d055 into master Jun 23, 2020
@vgramer vgramer deleted the docs branch June 23, 2020 12:32
@vgramer vgramer added kind/documentation Categorizes issue or PR as related to documentation and removed documentation Improvements or additions to documentation labels Apr 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants