Skip to content

Commit

Permalink
Update docs (#472)
Browse files Browse the repository at this point in the history
* move docs files

* update docs from template

* another update

* add insights callouts

* add ingress check to the docs

* remove old prefixes on check names
  • Loading branch information
rbren committed Jan 15, 2021
1 parent 744e40a commit 9e0ed9e
Show file tree
Hide file tree
Showing 81 changed files with 117 additions and 839 deletions.
33 changes: 31 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,31 @@ jobs:
- *set_environment_variables
- *docker_build_and_push

publish_docs:
docker:
- image: cimg/node:15.5.1
steps:
- checkout
- run:
name: Build Docs Site
command: |
set -e
cd ./docs
npm install
npm run check-links
npm run build
- run:
name: Install AWS CLI
command: |
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install
- run:
name: Publish Docs Site to S3
command: |
cd ./dist
aws s3 sync ./ s3://polaris.docs.fairwinds.com --delete
workflows:
version: 2

Expand Down Expand Up @@ -224,7 +249,6 @@ workflows:
filters:
branches:
ignore: /.*/
# Testing tags are reserved for testing circle test + build steps
tags:
ignore: /^testing-.*/
- release_images:
Expand All @@ -234,6 +258,11 @@ workflows:
filters:
branches:
ignore: /.*/
# Testing tags are reserved for testing circle test + build steps
tags:
ignore: /^testing-.*/
- publish_docs:
filters:
branches:
ignore: /.*/
tags:
ignore: /^testing-.*/
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ dist
*-test.yaml

node_modules
/dist
12 changes: 0 additions & 12 deletions docs-md/.vuepress/public/scripts/leadlander.js

This file was deleted.

File renamed without changes.
2 changes: 1 addition & 1 deletion docs-md/.vuepress/config.js → docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ const baseConfig = {
head: [
['link', { rel: 'icon', href: '/favicon.png' }],
['script', { src: '/scripts/modify.js' }],
['script', { src: '/scripts/leadlander.js' }],
['script', { src: '/scripts/marketing.js' }],
],
themeConfig: {
docsRepo: "",
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
29 changes: 29 additions & 0 deletions docs/.vuepress/public/scripts/marketing.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* This file is generated from FairwindsOps/documentation-template
* DO NOT EDIT MANUALLY
*/

var llcookieless = true;
var sf14gv = 32793;
(function() {
var sf14g = document.createElement('script');
sf14g.src = 'https://lltrck.com/lt-v2.min.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(sf14g, s);
})();

!function(f,b,e,v,n,t,s)
{if(f.fbq)return;n=f.fbq=function(){n.callMethod?
n.callMethod.apply(n,arguments):n.queue.push(arguments)};
if(!f._fbq)f._fbq=n;n.push=n;n.loaded=!0;n.version=‘2.0;
n.queue=[];t=b.createElement(e);t.async=!0;
t.src=v;s=b.getElementsByTagName(e)[0];
s.parentNode.insertBefore(t,s)}(window, document,‘script’,
‘https://connect.facebook.net/en_US/fbevents.js’);
fbq(‘init’, ‘159554595936922’);
fbq(‘track’, ‘PageView’);

(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({‘gtm.start’:
new Date().getTime(),event:‘gtm.js’});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!=‘dataLayer’?&l=+l:‘’;j.async=true;j.src=
’https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,‘script’,‘dataLayer’,‘GTM-K5KK5H3’);
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
22 changes: 0 additions & 22 deletions docs/404.html

This file was deleted.

1 change: 0 additions & 1 deletion docs/CNAME

This file was deleted.

2 changes: 1 addition & 1 deletion docs-md/README.md → docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Polaris can be run in three different modes:
<img src="/img/FW_Insights_Polaris.svg" alt="Fairwinds Insights" width="550"/>
</p>

[Fairwinds Insights](https://www.fairwinds.com/insights?utm_campaign=Hosted%20Polaris%20&utm_source=polaris&utm_term=polaris&utm_content=polaris)
[Fairwinds Insights](https://www.fairwinds.com/fairwinds-polaris-upgrade)
is a platform for auditing Kubernetes clusters and enforcing policy. If you'd like to:
* manage Polaris across a fleet of clusters
* track findings over time
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Admission Controller
> Want to manage the Admission Controller across multiple clusters? Check out
> [Fairwinds Insights](https://www.fairwinds.com/fairwinds-polaris-upgrade)
Polaris can be run as an admission controller that acts as a validating webhook.
This accepts the same configuration as the dashboard, and can run the same validations.

Expand Down
45 changes: 0 additions & 45 deletions docs/admission-controller/index.html

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/css/0.styles.db69974e.css

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/img/search.83621669.svg

This file was deleted.

Loading

0 comments on commit 9e0ed9e

Please sign in to comment.