Initial version of new documentation for mini-site.

doughoke · Nov 11, 2020 · 949d52c · 949d52c
1 parent 225f00f
commit 949d52c
Show file tree

Hide file tree

Showing 14 changed files with 119 additions and 0 deletions.
diff --git a/docs/about.md b/docs/about.md
diff --git a/docs/architecture.md b/docs/architecture.md
diff --git a/docs/contribution.md b/docs/contribution.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -0,0 +1,17 @@
+## Installation
+
+This section describes installation procedure of ICE.
+
+To have a fully working environment to use and develop in ICE you will need:
+
+1. Download and install Go: https://golang.org/dl/
+2. Install VS Code (or another IDE of your choosing): https://code.visualstudio.com/Download
+3. Inside VS Code, install the following extensions:
+ - Go
+ - Open Policy Agent
+ - Git Lens 
+4. Install PostgreSQL: https://www.postgresql.org/download/ (optional, not needed for CLI usage)
+5. Clone the repository of ICE to VS Code: https://github.com/CheckmarxDev/ice
+6. Test if the application is running properly by running in the terminal, in the root of the project:
+
+go run ./cmd/console/main.go -p assets/queries/terraform
diff --git a/docs/img/logo-ansible.png b/docs/img/logo-ansible.png
diff --git a/docs/img/logo-docker.png b/docs/img/logo-docker.png
diff --git a/docs/img/logo-k8s.png b/docs/img/logo-k8s.png
diff --git a/docs/img/logo-terraform.svg b/docs/img/logo-terraform.svg
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,55 @@
+## Welcome
+
+KICS (pronounced as 'kick-s') is an open source solution for static code analysis of Infrastructure as Code.
+
+Cloud Infrastructure as Code Security (or in short CICS, or just KICS) is a must-have for any cloud native project. With KICS, finding security vulnerabilities, compliance issues, and infrastructure misconfigurations happens early in the development cycle, when fixing these is straightforward and cheap.
+
+It is as simple as running a CLI tool, making it easy to integrate into any project CI.
+
+#### Supported Platforms
+
+KICS scans and detects issues in following Infrastructure as Code solutions:
+
+<img alt="Terraform" src="img/logo-terraform.svg" width="150">&nbsp;&nbsp;&nbsp;
+<img alt="Docker" src="img/logo-docker.png" width="150">&nbsp;&nbsp;&nbsp;
+<img alt="Kubernetes" src="img/logo-k8s.png" width="150">&nbsp;&nbsp;&nbsp;
+<img alt="Ansible" src="img/logo-ansible.png" width="150">
+
+More solutions, such as AWS CloudFormation are planned to be added [soon](roadmap.md).
+
+
+## Getting Started
+
+Setting up and using KICS is super-easy.
+
+- First, see how to [install and get KICS running](getting-started.md).
+- Next, check how you can easily [integrate it into your CI](integrations.md) for any project.
+- Eventually, [explore the output results format](results.md) and quickly fix the issues detected.
+
+## How it Works
+
+What makes KICS really powerful and popular is its built-in extensibility. This extensibility is achieved by:
+
+- Fully customizable and adjustable heuristics rules, called [queries](queries.md). These can be easily edited, extended, and added.
+- Robust but yet simple [architecture](architecture.md), which allows quick addition of support for new Infrastructure as Code solutions.
+
+
+## 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.
+
+## About the Project
+
+The [KICS project](about.md) is powered by [Checkmarx](https://www.checkmarx.com/), global leader of Application Security Testing.
+
+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**.  
+
+Now, Software <span style="color: #5FBB46">**=**</span> **Security**.
+
+Looking for more info? Explore KICS project in details:
+
+- [Roadmap](roadmap.md)
+- [Project plans](https://github.com/CheckmarxDev/ice/projects)
+- [Issues](https://github.com/CheckmarxDev/ice/issues)
diff --git a/docs/integrations.md b/docs/integrations.md
diff --git a/docs/queries.md b/docs/queries.md
diff --git a/docs/results.md b/docs/results.md
diff --git a/docs/roadmap.md b/docs/roadmap.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,40 @@
+# Project
+site_name: KICS
+site_url: http://www.igormarkov.com
+site_description: >-
+  Open source solution for static code analysis of Infrastructure as Code. Finding security vulnerabilities, compliance issues, and infrastructure misconfigurations during project development cycle.
+copyright:  >-
+  &copy; 2020 Checkmarx Ltd. All Rights Reserved.
+
+
+# Repo
+repo_name: GitHub
+repo_url: https://github.com/CheckmarxDev/ice/
+
+
+# Navigation
+nav:
+  - Home: index.md
+  - Install:
+    - Getting Started: getting-started.md
+    - Integrations: integrations.md
+    - Results: results.md
+  - Queries: queries.md
+  - Architecture: architecture.md
+  - Contribution: contribution.md
+  - Project:
+    - Roadmap: roadmap.md
+    - Plans: 'https://github.com/CheckmarxDev/ice/projects'
+    - Issues: 'https://github.com/CheckmarxDev/ice/issues'
+  - About: about.md
+
+# Theme
+theme:
+  name: spacelab
+  # nav_style: dark
+  logo: img/logo-terraform.svg
+  favicon: img/favicon.ico
+
+# Plugins
+plugins:
+  - search