Green-Software-Foundation / carbon-aware-sdk

Carbon-Aware SDK
https://carbon-aware-sdk.greensoftware.foundation/
MIT License
464 stars 98 forks source link

Add disclaimer banner to any public-facing documentation (docusaurus webpage) #416

Closed Sophietn closed 7 months ago

Sophietn commented 10 months ago

Banner disclaimer wording:

[!important] Incubation Project This project is an incubation project being run inside the Green Software Foundation; as such, we *DON’T recommend using it in any critical use case. Incubation projects are experimental, offer no support guarantee, have minimal governance and process, and may be retired at any moment. This project may one day graduate, in which case this disclaimer will be removed.

danuw commented 9 months ago

Example banner given by @Sophietn currently visible at https://if.greensoftware.foundation/

Image

Sophietn commented 9 months ago

Here's the PR for adding it to the IF document website, in the IF-docs repo https://github.com/Green-Software-Foundation/if-docs/pull/11

danuw commented 7 months ago

trying to use https://docusaurus.io/docs/api/themes/configuration#announcement-bar - adding link for reference

as well as this https://docusaurus.io/docs/styling-layout#global-styles for options that are not yet available and need overriding

danuw commented 7 months ago

@Sophietn can you double check - should look something like below.

Please note, using out of the box announcement bar, so disclaimer can be closed and should only reappear on the same browser when we increment the announcement id.

medium size screen big size screen small size/mobile size screen
danuw commented 7 months ago

I have since bolded the message

big size screen bold message
Sophietn commented 7 months ago

LGTM thank you

Sophietn commented 7 months ago

Happy to close this issue @danuw ?