From c8fb62ed7625b3a0a43e667de0a1cad8379b31c3 Mon Sep 17 00:00:00 2001 From: Stacey Salamon <111294980+staceysalamon-aiven@users.noreply.github.com> Date: Thu, 29 Feb 2024 11:03:38 +0100 Subject: [PATCH] add(platform): carbon footprint doc (#17) --- .vscode/aiven.code-snippets | 3 +-- docs/platform/concepts/carbon-footprint.md | 19 +++++++++++++++++++ sidebars.ts | 1 + 3 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 docs/platform/concepts/carbon-footprint.md diff --git a/.vscode/aiven.code-snippets b/.vscode/aiven.code-snippets index 5a0af3a8..e9de4796 100644 --- a/.vscode/aiven.code-snippets +++ b/.vscode/aiven.code-snippets @@ -16,9 +16,8 @@ "scope": "markdown", "prefix": "Required access", "body": [ - ":::info", + "## Required access", "You must be a ${1|[super admin](/docs/platform/howto/make-super-admin),[project admin](/docs/platform/reference/project-member-privileges),[project operator](/docs/platform/reference/project-member-privileges)|} to access this feature.", - ":::" ], "description": "Inserts a section with information on what role is needed to access a feature" }, diff --git a/docs/platform/concepts/carbon-footprint.md b/docs/platform/concepts/carbon-footprint.md new file mode 100644 index 00000000..083b0ba7 --- /dev/null +++ b/docs/platform/concepts/carbon-footprint.md @@ -0,0 +1,19 @@ +--- +title: Carbon footprint +early: true +--- + +You must be a [super admin](/docs/platform/howto/make-super-admin) to access this feature. + +The carbon footprint page shows estimates of the greenhouse gas emissions associated with service usage per project in your organization. + +Emissions are measured in metric tons of carbon dioxide-equivalent, which includes +multiple greenhouse gasses. The following information is shown on the dashboard for the +selected project: + +- Estimated emissions for the month: Shows a running estimate of emissions for the + current calendar month. +- Monthly carbon emissions: Shows an estimate of the emissions for the last 3, 6, and + 12 months. + +To view your emissions data, go to **Admin** > **Carbon footprint**. diff --git a/sidebars.ts b/sidebars.ts index 5a0b8496..fce1b93e 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -53,6 +53,7 @@ const sidebars: SidebarsConfig = { 'platform/howto/add-project-members', 'platform/reference/project-member-privileges', 'platform/howto/manage-unassigned-projects', + 'platform/concepts/carbon-footprint', ], }, {