Skip to content

Terrascan v1.0 docs #288

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

Merged
merged 23 commits into from
Aug 16, 2020
Merged

Terrascan v1.0 docs #288

merged 23 commits into from
Aug 16, 2020

Conversation

cesar-rodriguez
Copy link
Contributor

@cesar-rodriguez cesar-rodriguez commented Aug 16, 2020

Adds:

  • Release notes
  • Architecture
  • Policy reference
  • Getting started guide

Fixes a bug on the Dockerfile

You can preview the rendered docs here: https://docs.accurics.com/projects/accurics-terrascan/en/terrascan-v1.0-docs/

@codecov
Copy link

codecov bot commented Aug 16, 2020

Codecov Report

Merging #288 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #288   +/-   ##
=======================================
  Coverage   60.08%   60.08%           
=======================================
  Files          48       48           
  Lines         982      982           
=======================================
  Hits          590      590           
  Misses        344      344           
  Partials       48       48           

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Contributor

@kanchwala-yusuf kanchwala-yusuf left a comment

Choose a reason for hiding this comment

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

We should also consider adding an examples folder in which we have actual working examples of all terrascan commands and options with an intention that user can run these commands from the root of the terrascan repository and all the examples should work fine.

@@ -30,13 +30,6 @@ $ install terrascan /usr/local/bin
$ terrascan --help
```

Copy link
Contributor

Choose a reason for hiding this comment

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

We should consider adding a section on installing terrascan from source code

@kanchwala-yusuf kanchwala-yusuf merged commit 4a318e3 into master Aug 16, 2020
@kanchwala-yusuf kanchwala-yusuf deleted the terrascan-v1.0-docs branch August 16, 2020 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants