SWI Guidance

Explanatory guidance, worked examples, and data-source references for implementers calculating a Software Water Intensity (SWI) score. This site is a non-normative companion to the SWI Specification: the specification states requirements (shall / should / may); this guidance explains how to fulfil them.

This project is a draft work item of the Green Software Foundation's Standards Working Group (SSWG). It is not yet officially endorsed, and its content should be expected to change as the SSWG resolves the open questions tracked in docs/OpenQuestions.md.

This project follows the structure and conventions of the GSF's SCI Data & Guidance project, which occupies the same role for the Software Carbon Intensity (SCI) specification.

Copyright

Content in this repository is licensed under CC-BY-4.0. Code (the site itself) is licensed under MIT.

Patent

No patent rights are asserted over the contents of this repository.

License

See LICENSE for the code license (MIT). Documentation content is CC-BY-4.0 as noted above.

Contributing

See CONTRIBUTING.md for the branching model and review process. All contributions are subject to the Code of Conduct.

Editing Content

All guidance content lives under docs/. Each folder corresponds to a major component of the SWI formula or a supporting topic; each page carries front matter (sidebar_position) that controls its place in the sidebar, which is otherwise auto-generated from the docs/ folder structure — there is no sidebars.js list to hand-maintain when adding a page.

Every generated page opens with an HTML comment identifying which section(s) of SWI-Specification.md and which Guideline Requirement number(s) in SWI-Guidelines-Requirements-Analysis.md (see source/) it is grounded in, so provenance can be traced back to source SSWG discussion.

Developing Locally

yarn install
yarn start

This starts a local development server and opens a browser window. Most changes are reflected live without restarting the server.

yarn build

This generates static content into the build directory, which can be served by any static hosting service.

Site Configuration

The site is built with Docusaurus 2. Configuration lives in docusaurus.config.js (site metadata, navbar, footer) and sidebars.js (autogenerated sidebar). The draft-state banner is added by a swizzled src/theme/Navbar/index.js.

Deployment

Three branches are used, following the SCI Data & Guidance model:

• dev — the working branch; all pull requests target dev.
• main — the reviewed, "official GSF version" of the content.
• web — the branch that is actually deployed. Netlify is connected to this branch and builds/publishes it directly on every push, using the settings in netlify.toml (yarn build, publishing the build directory).