Merge pull request #94 from cncf-tags/revert-docs-website

Revert changes for dedicated documentation website
cncf-tags · Jun 10, 2024 · eb0b41d · eb0b41d
2 parents 50fa8aa + 65f5373
commit eb0b41d
Show file tree

Hide file tree

Showing 63 changed files with 34 additions and 10,591 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,3 @@
 infrastructure/equinix-metal/.terraform/
 infrastructure/equinix-metal/terraform.tfvars
-infrastructure/equinix-metal/.terraform.lock.hcl
-website/public/
-website/resources/
-website/node_modules/
+infrastructure/equinix-metal/.terraform.lock.hcl
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -43,9 +43,9 @@ Recommendations for a faster Pull Request review:
 
 ### Proposals
 
-For larger feature requests, please submit a design proposal in [website/content/docs/proposals/](./website/content/docs/proposals/). This is similar to a [Kubernetes Enhancement Proposal (KEP)](https://github.com/kubernetes/enhancements) or a [Architecture Decision Record (ADR)](https://adr.github.io/).
+For larger feature requests, please submit a design proposal in [docs/proposals/](./docs/proposals/). This is similar to a [Kubernetes Enhancement Proposal (KEP)](https://github.com/kubernetes/enhancements) or a [Architecture Decision Record (ADR)](https://adr.github.io/).
 
-First, create a copy of the template found in the proposal directory, [website/content/docs/proposals/proposal-000-template.md](./website/content/docs/proposals/proposal-000-template.md). Rename the file to the next number in the sequence and add a name for the proposal e.g. `proposal-001-my-feature.md`. Fill in the required fields, then open a PR for review.
+First, create a copy of the template found in the proposal directory, [docs/proposals/proposal-000-template.md](./docs/proposals/proposal-000-template.md). Rename the file to the next number in the sequence and add a name for the proposal e.g. `proposal-001-my-feature.md`. Fill in the required fields, then open a PR for review.
 
 The initial PR can be a barebone PR with the goals/non-goals sections clarified that can be merged quickly and iterated on.
 

diff --git a/README.md b/README.md
@@ -22,18 +22,7 @@ If you are interested in contributing to the project, head over to the [Contribu
 
 ### Documentation
 
-All the documentation for Green Reviews WG is moved to a dedicated website that's publicly available at [https://docs.green-reviews.tag-env-sustainability.cncf.io/](https://docs.green-reviews.tag-env-sustainability.cncf.io/).
-All changes to the documentation must be added to [website/content/docs](./website/content/docs/) folder. Documentation is built on top of the [Doks theme](https://getdoks.org/docs/start-here/getting-started) powered by Hugo. Website is deployed via Netlify.
-
-To run website locally, run the following commands (requires ```npm```):
-
-``` bash
-cd website
-npm run install
-npm run dev
-```
-
-More documentation for further development of the website can be found in [Doks theme docs](https://getdoks.org/docs/start-here/getting-started)😁
+All changes to the documentation must be added to [website/content/docs](./docs/) folder.
 
 ## Roadmap
 

diff --git a/docs/cncf-projects/_index.md b/docs/cncf-projects/_index.md
@@ -0,0 +1,10 @@
+---
+title: "CNCF Projects"
+description: ""
+summary: ""
+date: 2023-09-07T16:06:50+02:00
+lastmod: 2023-09-07T16:06:50+02:00
+draft: false
+weight: 800
+toc: true
+---
diff --git a/...ntent/docs/cncf-projects/cncf-projects.md → docs/cncf-projects/cncf-projects.md b/...ntent/docs/cncf-projects/cncf-projects.md → docs/cncf-projects/cncf-projects.md
@@ -8,11 +8,6 @@ draft: false
 slug: cncf-projects-collaboration
 weight: 810
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 This project aims to provide an architectural reference for how to assess the sustainability footprint of a cloud-native application (including the SCI) using cloud-native tooling. The community cluster aims to provide a playground for emerging metrics related to environmental sustainability, such as the [Software Carbon Intensity (SCI) specification](https://sci-guide.greensoftware.foundation). The Green Reviews pipeline is also inspired by the process established by [TAG Security’s Security Assessment (TSSA)](https://github.com/cncf/tag-security/tree/main/assessments) for CNCF Projects.

diff --git a/website/content/docs/cncf-projects/falco.md → docs/cncf-projects/falco.md b/website/content/docs/cncf-projects/falco.md → docs/cncf-projects/falco.md
@@ -8,11 +8,6 @@ draft: false
 slug: falco
 weight: 820
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 This section is a work in progress. See [cncf-green-review-testing](https://github.com/falcosecurity/cncf-green-review-testing) for more details around collaboration between Falco and CNCF TAG ENV Green Reviews WG.
diff --git a/docs/infrastructure/_index.md b/docs/infrastructure/_index.md
@@ -0,0 +1,10 @@
+---
+title: "Infrastructure"
+description: ""
+summary: ""
+date: 2023-09-07T16:06:50+02:00
+lastmod: 2023-09-07T16:06:50+02:00
+draft: false
+weight: 830
+toc: true
+---
diff --git a/website/content/docs/infrastructure/about.md → docs/infrastructure/about.md b/website/content/docs/infrastructure/about.md → docs/infrastructure/about.md
@@ -8,11 +8,6 @@ draft: false
 slug: about
 weight: 840
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 ## Provisioning Infrastructure & Cluster

diff --git a/...frastructure/cluster-infra-development.md → ...frastructure/cluster-infra-development.md b/...frastructure/cluster-infra-development.md → ...frastructure/cluster-infra-development.md
@@ -8,11 +8,6 @@ draft: false
 slug: cluster-infra-development
 weight: 850
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 ## Overview

diff --git a/...ntent/docs/infrastructure/install-flux.md → docs/infrastructure/install-flux.md b/...ntent/docs/infrastructure/install-flux.md → docs/infrastructure/install-flux.md
@@ -8,11 +8,6 @@ draft: false
 slug: flux-install
 weight: 860
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 To install Flux manually run the following:

diff --git a/...ent/docs/infrastructure/install-kepler.md → docs/infrastructure/install-kepler.md b/...ent/docs/infrastructure/install-kepler.md → docs/infrastructure/install-kepler.md
@@ -8,11 +8,6 @@ draft: false
 slug: kepler-install
 weight: 870
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 Full installation of Kepler with dashboard.

diff --git a/...docs/infrastructure/microservices-demo.md → docs/infrastructure/microservices-demo.md b/...docs/infrastructure/microservices-demo.md → docs/infrastructure/microservices-demo.md
@@ -8,11 +8,6 @@ draft: false
 slug: microservice-demo-install
 weight: 880
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 ## Manual installation

diff --git a/...cs/infrastructure/read-only-kubeconfig.md → docs/infrastructure/read-only-kubeconfig.md b/...cs/infrastructure/read-only-kubeconfig.md → docs/infrastructure/read-only-kubeconfig.md
@@ -8,11 +8,6 @@ draft: false
 slug: cluster-access
 weight: 890
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 ## Read only kubeconfig

diff --git a/website/content/docs/measurement/_index.md → docs/measurement/_index.md b/website/content/docs/measurement/_index.md → docs/measurement/_index.md
@@ -7,9 +7,4 @@ lastmod: 2023-09-07T16:06:50+02:00
 draft: false
 weight: 900
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
diff --git a/website/content/docs/measurement/sci.md → docs/measurement/sci.md b/website/content/docs/measurement/sci.md → docs/measurement/sci.md
@@ -8,11 +8,6 @@ draft: false
 slug: sci
 weight: 910
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 The [Software Carbon Intensity (SCI) specification][1] by the [Green Software Foundation](https://greensoftware.foundation) is a method for **scoring** a software system based on the components that emit carbon.

diff --git a/docs/proposals/_index.md b/docs/proposals/_index.md
@@ -0,0 +1,10 @@
+---
+title: "Proposals"
+description: ""
+summary: ""
+date: 2023-09-07T16:06:50+02:00
+lastmod: 2023-09-07T16:06:50+02:00
+draft: false
+weight: 920
+toc: true
+---
diff --git a/...t/docs/proposals/proposal-000-template.md → docs/proposals/proposal-000-template.md b/...t/docs/proposals/proposal-000-template.md → docs/proposals/proposal-000-template.md
@@ -8,11 +8,6 @@ draft: false
 slug: 000-proposal-template
 weight: 940
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 <!--

diff --git a/...ocs/proposals/proposal-template-how-to.md → docs/proposals/proposal-template-how-to.md b/...ocs/proposals/proposal-template-how-to.md → docs/proposals/proposal-template-how-to.md
@@ -8,11 +8,6 @@ draft: false
 slug: proposal-template-how-to
 weight: 930
 toc: true
-seo:
- title: "" # custom title (optional)
- description: "" # custom description (recommended)
- canonical: "" # custom canonical URL (optional)
- noindex: false # false (default) or true
 ---
 
 How to use the proposal template:

diff --git a/netlify.toml b/netlify.toml
diff --git a/website/.editorconfig b/website/.editorconfig
diff --git a/website/.eslintignore b/website/.eslintignore
diff --git a/website/.eslintrc.json b/website/.eslintrc.json
diff --git a/website/.gitpod.yml b/website/.gitpod.yml
diff --git a/website/.hugo_build.lock b/website/.hugo_build.lock
diff --git a/website/.markdownlint-cli2.jsonc b/website/.markdownlint-cli2.jsonc
diff --git a/website/.npmignore b/website/.npmignore
diff --git a/website/.npmrc b/website/.npmrc
diff --git a/website/.stylelintignore b/website/.stylelintignore
diff --git a/website/.stylelintrc.json b/website/.stylelintrc.json
diff --git a/website/assets/cover.png b/website/assets/cover.png
diff --git a/website/assets/favicon.ico b/website/assets/favicon.ico
diff --git a/website/assets/favicon.png b/website/assets/favicon.png
diff --git a/website/assets/favicon.svg b/website/assets/favicon.svg
diff --git a/website/assets/images/.gitkeep b/website/assets/images/.gitkeep
diff --git a/website/assets/js/custom.js b/website/assets/js/custom.js
diff --git a/website/assets/mask-icon.svg b/website/assets/mask-icon.svg
diff --git a/website/assets/scss/common/_custom.scss b/website/assets/scss/common/_custom.scss
diff --git a/website/assets/scss/common/_variables-custom.scss b/website/assets/scss/common/_variables-custom.scss
diff --git a/website/assets/svgs/.gitkeep b/website/assets/svgs/.gitkeep