diff --git a/docs/1.Welcome/Feature Descriptions.md b/docs/1.Welcome/Feature Descriptions.md index cfe1cecfe77..46ae3a9cd2f 100644 --- a/docs/1.Welcome/Feature Descriptions.md +++ b/docs/1.Welcome/Feature Descriptions.md @@ -2,7 +2,7 @@ layout: default published: true title: Feature Descriptions -order: 4 +nav_order: 4 --- # Feature Descriptions diff --git a/docs/1.Welcome/Quick Start.md b/docs/1.Welcome/Quick Start.md index 94abbbe9958..40638b64487 100644 --- a/docs/1.Welcome/Quick Start.md +++ b/docs/1.Welcome/Quick Start.md @@ -2,7 +2,7 @@ layout: default published: true title: Quick Start -order: 3 +nav_order: 3 --- # Quick Start diff --git a/docs/1.Welcome/Terms and Concepts.md b/docs/1.Welcome/Terms and Concepts.md index 33b437e9756..7b56e330c25 100644 --- a/docs/1.Welcome/Terms and Concepts.md +++ b/docs/1.Welcome/Terms and Concepts.md @@ -2,7 +2,7 @@ layout: default published: true title: Terms and Concepts -order: 2 +nav_order: 2 --- # Terms and Concepts diff --git a/docs/1.Welcome/What is Checkov.md b/docs/1.Welcome/What is Checkov.md index ed5ebf3d1c3..3a5f1da3d0f 100644 --- a/docs/1.Welcome/What is Checkov.md +++ b/docs/1.Welcome/What is Checkov.md @@ -2,7 +2,7 @@ layout: default published: true title: What is Checkov? -order: 1 +nav_order: 1 --- # What is Checkov? diff --git a/docs/2.Basics/CLI Command Reference.md b/docs/2.Basics/CLI Command Reference.md index b243263c5ac..239bb6c527c 100644 --- a/docs/2.Basics/CLI Command Reference.md +++ b/docs/2.Basics/CLI Command Reference.md @@ -2,7 +2,7 @@ layout: default published: true title: CLI Command Reference -order: 2 +nav_order: 2 --- # CLI Command Reference diff --git a/docs/2.Basics/Handling Variables.md b/docs/2.Basics/Handling Variables.md index 4ff31023035..98c97f68f5a 100644 --- a/docs/2.Basics/Handling Variables.md +++ b/docs/2.Basics/Handling Variables.md @@ -2,7 +2,7 @@ layout: default published: true title: Handling Variables -order: 7 +nav_order: 7 --- # Handling Variables diff --git a/docs/2.Basics/Installing Checkov.md b/docs/2.Basics/Installing Checkov.md index bc9fbbffe4e..1aa37085026 100644 --- a/docs/2.Basics/Installing Checkov.md +++ b/docs/2.Basics/Installing Checkov.md @@ -2,7 +2,7 @@ layout: default published: true title: Installing Checkov -order: 1 +nav_order: 1 --- Installing Checkov is quick and straightforward—just install, configure input, and scan. diff --git a/docs/2.Basics/Reviewing Scan Results.md b/docs/2.Basics/Reviewing Scan Results.md index d0feb8a002d..7b92bbc8238 100644 --- a/docs/2.Basics/Reviewing Scan Results.md +++ b/docs/2.Basics/Reviewing Scan Results.md @@ -2,7 +2,7 @@ layout: default published: true title: Reviewing Scan Results -order: 5 +nav_order: 5 --- # Reviewing Scan Results diff --git a/docs/2.Basics/Scanning Credentials and Secrets.md b/docs/2.Basics/Scanning Credentials and Secrets.md index af3b58a190c..be2ee6a0c5d 100644 --- a/docs/2.Basics/Scanning Credentials and Secrets.md +++ b/docs/2.Basics/Scanning Credentials and Secrets.md @@ -2,7 +2,7 @@ layout: default published: true title: Scanning Credentials and Secrets -order: 4 +nav_order: 4 --- # Scanning Credentials and Secrets diff --git a/docs/2.Basics/Suppressing and Skipping Policies.md b/docs/2.Basics/Suppressing and Skipping Policies.md index d9632c8ac98..d21bf6da73b 100644 --- a/docs/2.Basics/Suppressing and Skipping Policies.md +++ b/docs/2.Basics/Suppressing and Skipping Policies.md @@ -2,7 +2,7 @@ layout: default published: true title: Suppressing and Skipping Policies -order: 3 +nav_order: 3 --- # Suppressing/skipping diff --git a/docs/2.Basics/Visualizing Checkov Output.md b/docs/2.Basics/Visualizing Checkov Output.md index 407423771c2..3db29132105 100644 --- a/docs/2.Basics/Visualizing Checkov Output.md +++ b/docs/2.Basics/Visualizing Checkov Output.md @@ -2,7 +2,7 @@ layout: default published: true title: Visualizing Checkov Output -order: 6 +nav_order: 6 --- # Visualizing Checkov Output in Bridgecrew diff --git a/docs/3.Custom Policies/Custom Policies Overview.md b/docs/3.Custom Policies/Custom Policies Overview.md index 2220a595e68..e220303867c 100644 --- a/docs/3.Custom Policies/Custom Policies Overview.md +++ b/docs/3.Custom Policies/Custom Policies Overview.md @@ -2,7 +2,7 @@ layout: default published: true title: Custom Policies Overview -order: 1 +nav_order: 1 --- # Custom Policies Overview diff --git a/docs/3.Custom Policies/Examples.md b/docs/3.Custom Policies/Examples.md index 8aac8a76216..845d0551ddf 100644 --- a/docs/3.Custom Policies/Examples.md +++ b/docs/3.Custom Policies/Examples.md @@ -2,7 +2,7 @@ layout: default published: true title: Custom YAML Policies Examples -order: 4 +nav_order: 4 --- # Examples - YAML-Based Custom Policies diff --git a/docs/3.Custom Policies/Python Custom Policies.md b/docs/3.Custom Policies/Python Custom Policies.md index 70501320e13..bc4dce93712 100644 --- a/docs/3.Custom Policies/Python Custom Policies.md +++ b/docs/3.Custom Policies/Python Custom Policies.md @@ -2,7 +2,7 @@ layout: default published: true title: Python Custom Policies -order: 2 +nav_order: 2 --- # Create Custom Policy - Python - Attribute Check diff --git a/docs/3.Custom Policies/Sharing Custom Policies.md b/docs/3.Custom Policies/Sharing Custom Policies.md index 3e37500f67b..9a3819e74b0 100644 --- a/docs/3.Custom Policies/Sharing Custom Policies.md +++ b/docs/3.Custom Policies/Sharing Custom Policies.md @@ -2,7 +2,7 @@ layout: default published: true title: Sharing Custom Policies -order: 5 +nav_order: 5 --- # Sharing Custom Policies diff --git a/docs/3.Custom Policies/YAML Custom Policies.md b/docs/3.Custom Policies/YAML Custom Policies.md index 5c31802b169..4f2ef41dc74 100644 --- a/docs/3.Custom Policies/YAML Custom Policies.md +++ b/docs/3.Custom Policies/YAML Custom Policies.md @@ -2,7 +2,7 @@ layout: default published: true title: YAML Custom Policies -order: 3 +nav_order: 3 --- # Create Custom Policy - YAML - Attribute Check and Composite diff --git a/docs/4.Integrations/Bitbucket Cloud Pipelines.md b/docs/4.Integrations/Bitbucket Cloud Pipelines.md index 43bcaad23ec..632ed63f0c2 100644 --- a/docs/4.Integrations/Bitbucket Cloud Pipelines.md +++ b/docs/4.Integrations/Bitbucket Cloud Pipelines.md @@ -2,7 +2,7 @@ layout: default published: true title: Bitbucket Cloud Pipelines -order: 2 +nav_order: 2 --- # Integrate Checkov with Bitbucket Cloud Pipelines diff --git a/docs/4.Integrations/Docker.md b/docs/4.Integrations/Docker.md index 6f0e5dd6a08..c52fa568f55 100644 --- a/docs/4.Integrations/Docker.md +++ b/docs/4.Integrations/Docker.md @@ -2,7 +2,7 @@ layout: default published: true title: Docker -order: 7 +nav_order: 7 --- # Using Checkov with Docker diff --git a/docs/4.Integrations/GitHub Actions.md b/docs/4.Integrations/GitHub Actions.md index 74b708ab271..edfb72ff5c4 100644 --- a/docs/4.Integrations/GitHub Actions.md +++ b/docs/4.Integrations/GitHub Actions.md @@ -2,7 +2,7 @@ layout: default published: true title: Github Actions -order: 3 +nav_order: 3 --- # Integrate Checkov with Github Actions diff --git a/docs/4.Integrations/GitLab CLI.md b/docs/4.Integrations/GitLab CLI.md index 282f674fb15..031b2c508e3 100644 --- a/docs/4.Integrations/GitLab CLI.md +++ b/docs/4.Integrations/GitLab CLI.md @@ -2,7 +2,7 @@ layout: default published: true title: GitLab CI -order: 4 +nav_order: 4 --- # Integrate Checkov with GitLab CI diff --git a/docs/4.Integrations/Jenkins.md b/docs/4.Integrations/Jenkins.md index 03329c74e93..ef4864e1acc 100644 --- a/docs/4.Integrations/Jenkins.md +++ b/docs/4.Integrations/Jenkins.md @@ -2,7 +2,7 @@ layout: default published: true title: Jenkins -order: 1 +nav_order: 1 --- # Integrate Checkov with Jenkins diff --git a/docs/4.Integrations/Kubernetes.md b/docs/4.Integrations/Kubernetes.md index 75cee25b6bf..0252b97eb93 100644 --- a/docs/4.Integrations/Kubernetes.md +++ b/docs/4.Integrations/Kubernetes.md @@ -2,7 +2,7 @@ layout: default published: true title: Kubernetes -order: 5 +nav_order: 5 --- # Integrate Checkov with Kubernetes diff --git a/docs/4.Integrations/Pre-Commit.md b/docs/4.Integrations/Pre-Commit.md index 0560308de26..d138da0720c 100644 --- a/docs/4.Integrations/Pre-Commit.md +++ b/docs/4.Integrations/Pre-Commit.md @@ -2,7 +2,7 @@ layout: default published: true title: Integrate Checkov with Pre-Commit -order: 6 +nav_order: 6 --- # Pre-Commit diff --git a/docs/4.Integrations/Terraform Scanning.md b/docs/4.Integrations/Terraform Scanning.md index 9ddcfa79a67..be1418ab727 100644 --- a/docs/4.Integrations/Terraform Scanning.md +++ b/docs/4.Integrations/Terraform Scanning.md @@ -2,7 +2,7 @@ layout: default published: true title: Terraform Scanning -order: 8 +nav_order: 8 --- # Terraform Plan and External Terraform Module Scanning diff --git a/docs/6.Contribution/Contribute New Terraform Provider.md b/docs/6.Contribution/Contribute New Terraform Provider.md index 660fae3438e..16c81739823 100644 --- a/docs/6.Contribution/Contribute New Terraform Provider.md +++ b/docs/6.Contribution/Contribute New Terraform Provider.md @@ -2,7 +2,7 @@ layout: default published: true title: Contribute New Terraform Provider -order: 4 +nav_order: 4 --- # Contribute New Terraform Provider diff --git a/docs/6.Contribution/Contribute Python-Based Policies.md b/docs/6.Contribution/Contribute Python-Based Policies.md index 409c991c678..c016775af61 100644 --- a/docs/6.Contribution/Contribute Python-Based Policies.md +++ b/docs/6.Contribution/Contribute Python-Based Policies.md @@ -2,7 +2,7 @@ layout: default published: true title: Contribute Python-Based Policies -order: 2 +nav_order: 2 --- # Contributing Python-based Custom Policies diff --git a/docs/6.Contribution/Contribute YAML-based Policies.md b/docs/6.Contribution/Contribute YAML-based Policies.md index b9b556fd157..82b698e37ef 100644 --- a/docs/6.Contribution/Contribute YAML-based Policies.md +++ b/docs/6.Contribution/Contribute YAML-based Policies.md @@ -2,7 +2,7 @@ layout: default published: true title: Contribute YAML-based Policies -order: 3 +nav_order: 3 --- # Contributing YAML-based Custom Policies diff --git a/docs/6.Contribution/Contribution Overview.md b/docs/6.Contribution/Contribution Overview.md index 50e110b40c1..6eba8524129 100644 --- a/docs/6.Contribution/Contribution Overview.md +++ b/docs/6.Contribution/Contribution Overview.md @@ -2,7 +2,7 @@ layout: default published: true title: Contribution Overview -order: 1 +nav_order: 1 --- # Contribution Overview diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 00000000000..40afa37aaf2 --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,35 @@ +source "https://rubygems.org" +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! +#gem "jekyll", "~> 4.2.0" +# This is the default theme for new Jekyll sites. You may change this to anything you like. +#gem "minima", "~> 2.5" +# If you want to use GitHub Pages, remove the "gem "jekyll"" above and +# uncomment the line below. To upgrade, run `bundle update github-pages`. +gem "github-pages", group: :jekyll_plugins +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.12" + gem "jekyll-redirect-from" + gem "jekyll-remote-theme" + gem "jekyll-get-json", "~> 1.0" +end + +# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem +# and associated library. +platforms :mingw, :x64_mingw, :mswin, :jruby do + gem "tzinfo", "~> 1.2" + gem "tzinfo-data" +end + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] + + +gem "jekyll-get-json", "~> 1.0" diff --git a/docs/_config.yml b/docs/_config.yml index cac806ded06..69e9536c43e 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -12,7 +12,8 @@ hljs_style: github-gist google_analytics: UA-156134275-1 plugins: - jekyll-redirect-from + - jekyll-remote-theme jekyll_get_json: - data: menus - json: 'menus.json' \ No newline at end of file + json: 'menus.json' diff --git a/docs/checkov-recording.gif b/docs/checkov-recording.gif index b3b5e24fb8c..ace04c82b62 100644 Binary files a/docs/checkov-recording.gif and b/docs/checkov-recording.gif differ