Umbraco.Community.Sustainability
A package from the Umbraco Community Sustainability Team which helps developers and editors see and improve the carbon impact of their websites.
Installation
[!IMPORTANT] v2.x supports Umbraco v14.x
v1.x supports Umbraco v10.8.x - v13.x
To understand more about which Umbraco CMS versions are actively supported by Umbraco HQ, please see Umbraco's Long-term Support (LTS) and End-of-Life (EOL) policy.
This package is available via NuGet.
To install the package, you can use either the .NET CLI:
dotnet add package Umbraco.Community.Sustainabilityor the NuGet Package Manager:
Install-Package Umbraco.Community.SustainabilityFeatures
Once installed, two new features are enabled:
Sustainability section
A section is enabled automatically for admin users that allows tracking of average stats based on recent tests, plus a breakdown of all scores per page.
Sustainability content app
On each content page, a Content App is added which allows users to see and benchmark page weight and carbon emissions, which is then converted to a carbon rating for individual pages.
Installation
Add the package to an existing Umbraco website from nuget:
dotnet add package Umbraco.Community.Sustainability
Once added, a new Content App will be available alongside your Umbraco pages allowing you to trigger a sustainability report.
Contributing
Contributions to this package are most welcome! Please read the Contributing Guidelines for how to get involved.
Here are some things for our roadmap:
- A visual review of the content app (particularly with v14/Belissima in mind)
- Dashboard
- Health checks
- Content and media warnings
- Configuration options
- Improved accuracy of reporting
License
Copyright © Rick Butterfield, Thomas Morris and other contributors.
Licensed under the MIT License.