Link fixes and page ordering for new docs (bridgecrewio#1041)

* config and gemfile for local rendering of docs * Fix page ordering Co-authored-by: barak <[email protected]>
Farfaday · Apr 8, 2021 · ce61251 · ce61251
1 parent 1bff8ed
commit ce61251
Show file tree

Hide file tree

Showing 31 changed files with 65 additions and 29 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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'
+    json: 'menus.json'
diff --git a/docs/checkov-recording.gif b/docs/checkov-recording.gif