Merge pull request #89 from cncf-tags/add-docs-website

Add documentation website

.gitignore

@@ -1,3 +1,6 @@
 infrastructure/equinix-metal/.terraform/
 infrastructure/equinix-metal/terraform.tfvars
-infrastructure/equinix-metal/.terraform.lock.hcl
+infrastructure/equinix-metal/.terraform.lock.hcl
+website/public/
+website/resources/
+website/node_modules/

CONTRIBUTING.md

@@ -12,18 +12,20 @@ Read on to learn more about the project and how to contribute. As always, please
 don't hesitate to ask if anything is unclear. We value questions, guidance, and
 suggestions - they help us build the right thing.
 
-### Finding Work
+## Finding Work
 
 Here are some suggestions for how to find work to contribute to the project.
 
 First, make sure you're up to speed with the project by looking through the resources in the [Getting Started](./README.md#getting-started) guide.
 
 Then, familiarise yourself with the current work and priorities, or find someone who would be willing to pair with you:
+
 - Join the twice monthly [WG meetings](https://github.com/cncf/tag-env-sustainability/tree/main/working-groups/green-reviews#meetings-and-contact).
 - [async] Leave a comment in any of the [issues](https://github.com/orgs/cncf/projects/10/views/12).
 - [async] Contribute to discussions in the CNCF Slack channel [#wg-green-reviews](https://cloud-native.slack.com/archives/C060EDHN431).
 
 When you feel ready to contribute:
+
 - Check the Backlog in the [issue board](https://github.com/orgs/cncf/projects/10/views/12). More pressing issues are labeled with `good first issue` or `help wanted`.
 - If you would like to make a feature request or raise a bug, feel free to [open an issue](https://github.com/cncf-tags/green-reviews-tooling/issues/new).
 - _If all else fails_, you could reach out to the [Green Review WG leads](https://github.com/cncf/tag-env-sustainability/tree/main/working-groups/green-reviews#chairs) directly with any queries. However, the public communication channels listed above are preferred so that we can load-balance the work.
@@ -33,16 +35,17 @@ We encourage all communication to remain public by going through the communicati
 ### Opening a Pull Request
 
 Recommendations for a faster Pull Request review:
+
 - Please ensure that your commits are **signed** and **verified**.
   - **Signed**: Include a `Signed-off-by: Author Name <[email protected]>` in all commits by doing `git rebase HEAD~2 --signoff` (replace `~2` with the number of commits to sign) and then `git push -f`. More info [here](https://github.com/cncf-tags/green-reviews-tooling/pull/53/checks?check_run_id=21563565653).
   - **Verified**: [Learn more about commit signature verification with GPG.](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#gpg-commit-signature-verification)
-- The Kubernetes Best Practices for faster Reviews is a great resource for PR best practices: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
+- The Kubernetes Best Practices for faster Reviews is a great resource for PR best practices: [Best practices for faster reviews](https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews)
 
 ### Proposals
 
-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/).
+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/).
 
-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.
+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.
 
 The initial PR can be a barebone PR with the goals/non-goals sections clarified that can be merged quickly and iterated on.
 

README.md

@@ -2,30 +2,48 @@
 
 The CNCF Green Reviews Working Group (WG) is an open-source, community-led project that is part of the [CNCF Environmental Sustainability Technical Advisory Group (TAG ENV)](https://github.com/cncf/tag-env-sustainability).
 
-The aim of the Green Reviews WG is to set up infrastructure to measure the sustainability footprint of [CNCF Projects](https://www.cncf.io/projects/).
+The aim of the Green Reviews WG is to set up infrastructure to measure the sustainability footprint of [CNCF Projects](https://www.cncf.io/projects).
 
 ## Community
 
 ### Getting Started
+
 Here are some resources to learn about the project:
+
 - **Charter**: The [Green Reviews WG Charter](https://github.com/cncf/tag-env-sustainability/blob/main/working-groups/green-reviews/charter.md) outlines the WG's motivation, scope, goals, non-goals, and deliverables.
 - **Issue Board**: Checkout the project's [Backlog](https://github.com/orgs/cncf/projects/10/views/12) to find something to work on.
-- **Design Document**: The [WG's design document](https://docs.google.com/document/d/19fzZW-IMv2kDNatKFHeHh7wqcEN0e2N60wzxvCGZd48/edit?usp=sharing) is a live document created and maintained by the open-source contributors of the WG. Everyone is welcome to contribute ideas, questions, comments, suggestions, and take ownership of the project's implementation.
+- **Design Document** (***Archived - please refer [Documentation section](#documentation) for latest updates***): The [WG's design document](https://docs.google.com/document/d/19fzZW-IMv2kDNatKFHeHh7wqcEN0e2N60wzxvCGZd48/edit?usp=sharing) is a live document created and maintained by the open-source contributors of the WG. Everyone is welcome to contribute ideas, questions, comments, suggestions, and take ownership of the project's implementation.
 
 ### Contributing
+
 All contributions are welcome, including code contributions, issues, suggestions, questions, product direction, collaborations, etc.
 
 If you are interested in contributing to the project, head over to the [Contributing Guide](./CONTRIBUTING.md)!
 
+### 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)😁
+
 ## Roadmap
 
 The roadmap contains some of the short and long-term goals of the Green Reviews WG. Timelines are estimates and may change.
 
 | Timeline | Goals |
 |---|---|
 | Q4 '23 / Before & After KubeCon NA  | Announce Green Reviews WG during KubeCon NA Keynotes  |
-| | Draft of the implementation for the sustainability footprint measurement workflow ([tracking issue]()) |
-| | Cluster up and running on Equinix ([tracking issue]()) |
+| | Draft of the implementation for the sustainability footprint measurement workflow (tracking issue) |
+| | Cluster up and running on Equinix (tracking issue) |
 | Q1 '24 / Before KubeCon EU  | Measure the cloud native sustainability footprint of Falco [milestone](https://github.com/cncf-tags/green-reviews-tooling/milestone/1) |
 | | Present architecture as part of the maintainer track at KubeCon EU  |
 | Q2 '24 / After KubeCon EU  | Automate cloud native sustainability footprint measuring of the Falco project (alpha version) |

netlify.toml

@@ -0,0 +1,2 @@
+[build]
+base = "website"

website/.editorconfig

@@ -0,0 +1,11 @@
+# editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

website/.eslintignore

@@ -0,0 +1 @@
+node_modules

website/.eslintrc.json

@@ -0,0 +1,31 @@
+{
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es6": true,
+    "node": true
+  },
+  "extends": "eslint:recommended",
+  "globals": {
+    "Atomics": "readonly",
+    "SharedArrayBuffer": "readonly"
+  },
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "module"
+  },
+  "rules": {
+    "no-console": 0,
+    "quotes": ["error", "single"],
+    "comma-dangle": [
+      "error",
+      {
+        "arrays": "always-multiline",
+        "objects": "always-multiline",
+        "imports": "always-multiline",
+        "exports": "always-multiline",
+        "functions": "ignore"
+      }
+    ]
+  }
+}

website/.gitpod.yml

@@ -0,0 +1,12 @@
+# Source:
+# - https://github.com/gitpod-io/template-hugo
+# - https://www.gitpod.io/docs/configure/workspaces/tasks#one-line-tasks
+
+tasks:
+  - name: Run development server
+    init: pnpm install
+    command: pnpm dev
+
+ports:
+  - port: 1313
+    onOpen: open-preview

website/.markdownlint-cli2.jsonc

@@ -0,0 +1,14 @@
+{
+  "config": {
+    "default": true,
+    "MD013": false,
+    "MD022": false,
+    "MD024": false,
+    "MD025": false,
+    "MD026": false,
+    "MD033": false,
+    "MD034": false,
+    "MD036": false
+  },
+  "ignores": ["node_modules", "CHANGELOG.md", "README.md"]
+}

website/.npmignore

@@ -0,0 +1,8 @@
+.eslintcache
+.stylelintcache
+.netlify
+.hugo_build.lock
+yarn-error.log
+node_modules
+public
+resources

website/.npmrc

@@ -0,0 +1,4 @@
+enable-pre-post-scripts = true
+auto-install-peers = true
+node-linker = hoisted
+prefer-symlinked-executables = false

website/.stylelintignore

@@ -0,0 +1,2 @@
+assets/scss/common/_variables-custom.scss
+node_modules

website/.stylelintrc.json

@@ -0,0 +1,35 @@
+{
+  "extends": "stylelint-config-standard-scss",
+  "rules": {
+    "no-empty-source": null,
+    "scss/comment-no-empty": null,
+    "scss/at-extend-no-missing-placeholder": null,
+    "at-rule-no-unknown": [
+      true,
+      {
+        "ignoreAtRules": [
+          "extend",
+          "at-root",
+          "debug",
+          "warn",
+          "error",
+          "if",
+          "else",
+          "for",
+          "each",
+          "while",
+          "mixin",
+          "include",
+          "content",
+          "return",
+          "function",
+          "tailwind",
+          "apply",
+          "responsive",
+          "variants",
+          "screen"
+        ]
+      }
+    ]
+  }
+}

website/assets/js/custom.js

@@ -0,0 +1 @@
+// Put your custom JS code here

website/assets/scss/common/_custom.scss

@@ -0,0 +1 @@
+// Put your custom SCSS code here

website/assets/scss/common/_variables-custom.scss

@@ -0,0 +1 @@
+// Put your custom SCSS variables here