Skip to content

Commit

Permalink
New docs update (Checkmarx#333)
Browse files Browse the repository at this point in the history
* Adding additional docs assets, and updating documentation.

* Fixing images location

* Fixing broken links in readme

* Updating logo

* Deleting CONTRIBUTING.md - irrelevant

* Minor readme changes.

* Site URL change

* Updating static site to include explicit link to repo

* Updated readme, added license placeholder

* Adding contribution page + updating 'about' page.
  • Loading branch information
Igor Markov authored Nov 23, 2020
1 parent 2f2f86f commit 9593b69
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ What makes KICS really powerful and popular is its built-in extensibility. This
## Contribution

KICS is a true community project. It's built as an open source from day one, and anyone can find his own way to contribute to the project.
[Check out how](docs/contribution.md), within just minutes, you can start making a difference, by sharing your expertise with a community of thousands of security experts and software developers.
[Check out how](docs/CONTRIBUTING.md), within just minutes, you can start making a difference, by sharing your expertise with a community of thousands of security experts and software developers.

## More

Expand Down
41 changes: 41 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## Contribution

We would like to THANK YOU for considering contributing to KICS!

## Contribution Options

TBD

## Get Started!

Follow the instructions below to setup local KICS development environment.

1. Fork the `kics` repo on GitHub.
2. Clone your fork locally:
```
$ git clone terrascan.git
```
3. Create a branch for local development:
```
$ git checkout -b name-of-your-issue
```
4. Make your changes locally.
5. Validate your changes to reassure they meet project quality and contribution standards:
```
$ fancy local command goes here
```
5. Commit your changes and push your branch to GitHub:
```
$ git add .
$ git commit
$ git push origin name-of-your-issue
```
6. Submit a pull request through GitHub website.

## Pull Request Guidelines

Before you submit a pull request, please reassure that it meets these guidelines:

1. All validations and tests passed locally.
1. The pull request includes tests.
1. The relevant docs are updated, whether you're pushing new functionality or updating a query.
12 changes: 10 additions & 2 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

## What is Infrastructure as Code

Infrastructure as code (IaC) is the process of managing and provisioning software through machine-readable definition files, rather than physical hardware configuration or interactive configuration tools.
Infrastructure as code (IaC) is the creation, provisioning and configuration of software-defined compute (SDC), networkand storage infrastructure through machine-readable definition files, rather than physical hardware configuration or interactive configuration tools.

IaC automates the manual tasks usually associated with computing infrastructure configuration and implementation.
By doing this, you can:
Expand All @@ -35,4 +35,12 @@ Main Benefits of IaC:
- Consistent environments
- Repeatable process
- Reusable components ("DRY")
- Documented Architecture
- Documented Architecture

---

## What is Infrastructure as Code Testing

IaC testing examines configuration definitions and scripts used to instantiate infrastructure to ensure the resulting resources are secure.

IaC security testing tools must be able to consume configuration files and scripts in relevant formats, apply tests to ensure conformance with common configuration hardening standards (i.e., Center for Internet Security Benchmarks and many others), identify security issues associated with specific operational environments, identify embedded secrets, and perform other tests supporting organization-specific standards and compliance requirements. Optionally, tools can automatically remediate errors (e.g., changing read/write permissions on storage resources). This capability specifically examines IaC testing in the context of the development process, however tools may also support examination of deployed production instances and responding to issues identified in those systems.
Empty file removed docs/contribution.md
Empty file.
8 changes: 6 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,18 @@ What makes KICS really powerful and popular is its built-in extensibility. This
## Contribution

KICS is a true community project. It's built as an open source from day one, and anyone can find his own way to contribute to the project.
[Check out how](contribution.md), within just minutes, you can start making a difference, by sharing your expertise with a community of thousands of security experts and software developers.
[Check out how](CONTRIBUTING.md), within just minutes, you can start making a difference, by sharing your expertise with a community of thousands of security experts and software developers.

- [How can I help?!](CONTRIBUTING.md)
- [Take me to the repo on GitHub!](https://github.com/CheckmarxDev/ice/)

- [How can I help?!](contribution.md)
- [Take me to the repo on GitHub!](https://github.com/CheckmarxDev/ice/)

## About the Project

The [KICS project](about.md) is powered by [Checkmarx](https://www.checkmarx.com/), global leader of Application Security Testing.
The KICS project is powered by [Checkmarx](https://www.checkmarx.com/), global leader of Application Security Testing.
[Read more](about.md) about **Infrastructure as Code**, **Infrastructure as Code Testing** and Checkmarx.

KICS will always stay an open source and free project for the benefit of global software industry community.
We believe that when **Software is Everywhere, Security is Everything**.
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ nav:
- Results: results.md
- Queries: queries.md
- Architecture: architecture.md
- Contribution: contribution.md
- Contribution: CONTRIBUTING.md
- Project:
- Roadmap: roadmap.md
- Plans: 'https://github.com/CheckmarxDev/ice/projects'
Expand Down

0 comments on commit 9593b69

Please sign in to comment.