go-vela / community

Community Information for Vela (Target's official Pipeline Automation Framework)
https://go-vela.github.io/docs/
Apache License 2.0
23 stars 3 forks source link

UI: Implement class "shell" across all cli contextual help. #978

Open KellyMerrick opened 5 months ago

KellyMerrick commented 5 months ago

Description

The class "shell" adds a green $ to the beginning of cli commands, making the commands more visually appealing, aligning to a standard of representing terminal commands with a leading shell element.

It is already implemented here, but implementing it correctly for all contextual help by replacing the input block with code [ class "shell" ] [ text command.content ] is more scope than intended for the pr where it was initialized.

Additional work will be needed to remove related form-control elements and some additional spans, remove related classes that would then be redundant, adjust styling/alignment for $, etc.

Value

Visual appeal, consistent implementation across the site, replacing input and related form-control with more appropriate elements, as technically the contextual help is not a form.

Definition of Done

The class "shell" implemented across the site, replacing input/form usage.

Effort (Optional)

2 days

Impacted Personas (Optional)

Everyone