pnp / cli-microsoft365

Manage Microsoft 365 and SharePoint Framework projects on any platform
https://aka.ms/cli-m365
MIT License
929 stars 326 forks source link

Include beta banner to command pages #4619

Open Jwaegebaert opened 1 year ago

Jwaegebaert commented 1 year ago

Currently, we have some commands that have beta enhancements. It would be helpful to add a banner at the top of the command page to inform users that certain features are only available in the current beta release. The banner can read "This command has features that are only available in the current beta release".

Additionally, when users click on the banner, they could be redirected to a page with instructions on how to install the latest beta release. This will help users easily access the beta version and try out the new enhancements.

Once a new release is made, all the banners will disappear.

milanholemans commented 1 year ago

We can get some ideas from PnP.PowerShell. They are currently using this:

image

milanholemans commented 1 year ago

Just to be clear, should we research if this is possible in mkdocs, or docusaurus? Since we are going to step away from mkdocs, I assume it's not worth researching this for mkdocs? Unless it would be a quick fix 🙂

Jwaegebaert commented 1 year ago

That's a good question, depends a bit on how we implement it. If we add it as an admonition then it won't be a problem during the migration. I think this would be a nice feature to add to the docs, so the Docusarus migration shouldn't hold it back IMO 😄

Adam-it commented 1 year ago

since we don't have it anyway for quite some time I guess there is no harm in introducing it to Docusarus. At least this is what I think 😉