Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert changes for dedicated documentation website #94

Merged
merged 1 commit into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 10 additions & 0 deletions docs/cncf-projects/_index.md
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 10 additions & 0 deletions docs/infrastructure/_index.md
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 10 additions & 0 deletions docs/proposals/_index.md
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

<!--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 0 additions & 2 deletions netlify.toml

This file was deleted.

11 changes: 0 additions & 11 deletions website/.editorconfig

This file was deleted.

1 change: 0 additions & 1 deletion website/.eslintignore

This file was deleted.

31 changes: 0 additions & 31 deletions website/.eslintrc.json

This file was deleted.

12 changes: 0 additions & 12 deletions website/.gitpod.yml

This file was deleted.

Empty file removed website/.hugo_build.lock
Empty file.
14 changes: 0 additions & 14 deletions website/.markdownlint-cli2.jsonc

This file was deleted.

8 changes: 0 additions & 8 deletions website/.npmignore

This file was deleted.

4 changes: 0 additions & 4 deletions website/.npmrc

This file was deleted.

2 changes: 0 additions & 2 deletions website/.stylelintignore

This file was deleted.

35 changes: 0 additions & 35 deletions website/.stylelintrc.json

This file was deleted.

Binary file removed website/assets/cover.png
Binary file not shown.
Binary file removed website/assets/favicon.ico
Binary file not shown.
Binary file removed website/assets/favicon.png
Binary file not shown.
1 change: 0 additions & 1 deletion website/assets/favicon.svg

This file was deleted.

Empty file removed website/assets/images/.gitkeep
Empty file.
1 change: 0 additions & 1 deletion website/assets/js/custom.js

This file was deleted.

1 change: 0 additions & 1 deletion website/assets/mask-icon.svg

This file was deleted.

1 change: 0 additions & 1 deletion website/assets/scss/common/_custom.scss

This file was deleted.

1 change: 0 additions & 1 deletion website/assets/scss/common/_variables-custom.scss

This file was deleted.

Empty file removed website/assets/svgs/.gitkeep
Empty file.
Loading