Update a11y text based on draft feedback
This commit is contained in:
Andy Feller
parent
274a09bbc9
commit
d7e2468286
2 changed files with 44 additions and 46 deletions
|
|
@ -12,7 +12,7 @@ import (
|
|||
)
|
||||
|
||||
const (
|
||||
communityURL = "https://github.com/orgs/community/discussions/categories/accessibility"
|
||||
feedbackURL = "https://accessibility.github.com/feedback"
|
||||
)
|
||||
|
||||
type AccessibilityOptions struct {
|
||||
|
|
@ -30,27 +30,27 @@ func NewCmdAccessibility(f *cmdutil.Factory) *cobra.Command {
|
|||
cmd := &cobra.Command{
|
||||
Use: "accessibility",
|
||||
Aliases: []string{"a11y"},
|
||||
Short: "Learn about GitHub CLI accessibility experience",
|
||||
Short: "Learn about GitHub CLI accessibility experiences",
|
||||
Long: longDescription(opts.IO),
|
||||
Hidden: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if opts.Web {
|
||||
if opts.IO.IsStdoutTTY() {
|
||||
fmt.Fprintf(opts.IO.ErrOut, "Opening %s in your browser.\n", text.DisplayURL(communityURL))
|
||||
fmt.Fprintf(opts.IO.ErrOut, "Opening %s in your browser.\n", text.DisplayURL(feedbackURL))
|
||||
}
|
||||
return opts.Browser.Browse(communityURL)
|
||||
return opts.Browser.Browse(feedbackURL)
|
||||
}
|
||||
|
||||
return cmd.Help()
|
||||
},
|
||||
Example: heredoc.Doc(`
|
||||
# Open the GitHub Community Accessibility discussions in your browser
|
||||
# Open the GitHub Accessibility site in your browser
|
||||
$ gh accessibility --web
|
||||
|
||||
# Display color using customizable, 4-bit accessible colors
|
||||
$ gh config set accessible_colors enabled
|
||||
|
||||
# Display issue and pull request labels using RGB hex color codes in terminals that support 24-bit truecolor
|
||||
# Display issue and pull request labels using RGB hex color codes in terminals that support 24-bit true color
|
||||
$ gh config set color_labels enabled
|
||||
|
||||
# Use input prompts without redrawing the screen
|
||||
|
|
@ -61,7 +61,7 @@ func NewCmdAccessibility(f *cmdutil.Factory) *cobra.Command {
|
|||
`),
|
||||
}
|
||||
|
||||
cmd.Flags().BoolVarP(&opts.Web, "web", "w", false, "Open the GitHub Community Accessibility discussions in the browser")
|
||||
cmd.Flags().BoolVarP(&opts.Web, "web", "w", false, "Open the GitHub Accessibility site in your browser")
|
||||
cmdutil.DisableAuthCheck(cmd)
|
||||
|
||||
return cmd
|
||||
|
|
@ -69,10 +69,11 @@ func NewCmdAccessibility(f *cmdutil.Factory) *cobra.Command {
|
|||
|
||||
func longDescription(io *iostreams.IOStreams) string {
|
||||
cs := io.ColorScheme()
|
||||
title := cs.Bold("LEARN ABOUT GITHUB CLI ACCESSIBILITY EFFORTS")
|
||||
color := cs.Bold("CUSTOMIZABLE AND CONTRASTING COLORS")
|
||||
prompter := cs.Bold("NON-INTERACTIVE USER INPUT PROMPTING")
|
||||
spinner := cs.Bold("TEXT-BASED SPINNERS")
|
||||
title := cs.Bold("Learn about GitHub CLI accessibility experiences")
|
||||
color := cs.Bold("Customizable and contrasting colors")
|
||||
prompter := cs.Bold("Non-interactive user input prompting")
|
||||
spinner := cs.Bold("Text-based spinners")
|
||||
feedback := cs.Bold("Join the conversation")
|
||||
|
||||
return heredoc.Docf(`
|
||||
%[2]s
|
||||
|
|
@ -81,70 +82,66 @@ func longDescription(io *iostreams.IOStreams) string {
|
|||
community and be empowered to contribute to the future of global software
|
||||
development with everything GitHub has to offer including the GitHub CLI.
|
||||
|
||||
We invite you to join us in improving GitHub CLI accessibility by sharing your
|
||||
feedback and ideas in the GitHub Community Accessibility discussions:
|
||||
%[3]s
|
||||
|
||||
Text interfaces often use color for various purposes, but insufficient contrast
|
||||
or customizability can leave some users unable to benefit.
|
||||
|
||||
%[4]s
|
||||
|
||||
Color is a common approach to enhance user experiences, however users can find
|
||||
themselves with a worse experience due to insufficient contrast or
|
||||
customizability.
|
||||
|
||||
To create an accessible experience, CLIs should use color palettes based on
|
||||
terminal background appearance and limit colors to 4-bit ANSI color palettes,
|
||||
which users can customize within terminal preferences.
|
||||
To create a more accessible experience, the GitHub CLI will use color palettes
|
||||
based on terminal background appearance and limit colors to 4-bit ANSI color
|
||||
palettes, which users can customize within terminal preferences.
|
||||
|
||||
With this new experience, the GitHub CLI provides multiple options to address
|
||||
color usage:
|
||||
|
||||
1. The GitHub CLI will use 4-bit color palette for increased color contrast based on
|
||||
dark and light backgrounds including rendering markdown based on GitHub Primer.
|
||||
1. The GitHub CLI will use 4-bit color palette for increased color contrast based
|
||||
on dark and light backgrounds including rendering Markdown based on the
|
||||
GitHub Primer design system.
|
||||
|
||||
To enable this experience, use one of the following methods:
|
||||
- Run %[1]sgh config set accessible_colors enabled%[1]s
|
||||
- Set %[1]sGH_ACCESSIBLE_COLORS=enabled%[1]s environment variable
|
||||
|
||||
2. The GitHub CLI will display issue and pull request labels' custom RGB colors
|
||||
in terminals with truecolor support.
|
||||
in terminals with true color support.
|
||||
|
||||
To enable this experience, use one of the following methods:
|
||||
- Run %[1]sgh config set color_labels enabled%[1]s
|
||||
- Set %[1]sGH_COLOR_LABELS=enabled%[1]s environment variable
|
||||
|
||||
%[4]s
|
||||
|
||||
%[5]s
|
||||
Interactive text user interfaces manipulate the terminal cursor to redraw parts
|
||||
of the screen, which can be difficult for speech synthesizers or braille displays
|
||||
to accurately detect and read.
|
||||
|
||||
Interactive text user interfaces are an advanced approach to enhance user
|
||||
experiences, which manipulate the terminal cursor to redraw parts of the screen.
|
||||
However, this can be difficult for speech synthesizers or braille displays to
|
||||
accurately detect and read.
|
||||
|
||||
To create an accessible experience, CLIs should give users the ability to disable
|
||||
this interactivity while providing a similar experience.
|
||||
|
||||
With this new experience, the GitHub CLI will use non-interactive prompts for
|
||||
user input.
|
||||
To create a more accessible experience, the GitHub CLI gives users the ability to
|
||||
disable this interactivity while providing a similar experience using
|
||||
non-interactive prompts for user input.
|
||||
|
||||
To enable this experience, use one of the following methods:
|
||||
- Run %[1]sgh config set accessible_prompter enabled%[1]s
|
||||
- Set %[1]sGH_ACCESSIBLE_PROMPTER=enabled%[1]s environment variable
|
||||
|
||||
%[5]s
|
||||
|
||||
%[6]s
|
||||
Motion-based spinners communicate in-progress activity by manipulating the
|
||||
terminal cursor to create a spinning effect, which can be difficult for users
|
||||
with motion sensitivity or miscommunicate information to speech synthesizers.
|
||||
|
||||
Motion-based spinners are a common approach to communicate activity, which
|
||||
manipulate the terminal cursor to create a spinning effect. However, this can be
|
||||
difficult for users with motion sensitivity as well as speech synthesizers.
|
||||
|
||||
To create an accessible experience, CLIs should give users the ability to disable
|
||||
this interactivity while providing a similar experience.
|
||||
|
||||
With this new experience, the GitHub CLI will use text-based progress indicators.
|
||||
To create a more accessible experience, the GitHub CLI gives users the ability to
|
||||
disable this interactivity while providing a similar experience using text-based
|
||||
progress indicators.
|
||||
|
||||
To enable this experience, use one of the following methods:
|
||||
- Run %[1]sgh config set spinner disabled%[1]s
|
||||
- Set %[1]sGH_SPINNER_DISABLED=yes%[1]s environment variable
|
||||
`, "`", title, communityURL, color, prompter, spinner)
|
||||
|
||||
%[6]s
|
||||
|
||||
We invite you to join us in improving GitHub CLI accessibility by sharing your
|
||||
feedback and ideas through GitHub Accessibility feedback channels:
|
||||
|
||||
%[7]s
|
||||
`, "`", title, color, prompter, spinner, feedback, feedbackURL)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -190,6 +190,7 @@ func rootHelpFunc(f *cmdutil.Factory, command *cobra.Command, _ []string) {
|
|||
Use %[1]sgh <command> <subcommand> --help%[1]s for more information about a command.
|
||||
Read the manual at https://cli.github.com/manual
|
||||
Learn about exit codes using %[1]sgh help exit-codes%[1]s
|
||||
Learn about accessibility experiences using %[1]sgh help accessibility%[1]s
|
||||
`, "`")})
|
||||
|
||||
out := f.IOStreams.Out
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue