oh-my-zsh VS axe-core

FROM registry.access.redhat.com/ubi9/python-311:latest # Install terraform & oh-my-zsh USER root RUN yum install -y yum-utils && \ yum-config-manager --add-repo https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo && \ yum -y install terraform zsh && \ wget https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | zsh USER 1001 # Install poetry RUN pip install poetry && \ poetry config virtualenvs.create false # Set default shell to zsh ENV SHELL /bin/zsh # Create workspace dir used by VSCode RUN mkdir /opt/app-root/src/workspace/ # Expose ports EXPOSE 4000

- name: Git clone oh-my-zsh ansible.builtin.command: 'git clone -c core.autocrlf=input --depth=1 https://github.com/robbyrussell/oh-my-zsh.git /home/zoliky/.oh-my-zsh' become: true become_user: zoliky when: not oh_my_zsh_dir.stat.exists

Z plugin change quickly to another path just naming the folder not the complete path

FROM node:18 RUN apt-get update # Install dependencies RUN apt-get install -y wget zsh git \ # Install oh-my-zsh RUN wget https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | zsh \ && cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc

# If you come from bash you might have to change your $PATH. # export PATH=$HOME/bin:/usr/local/bin:$PATH # Path to your oh-my-zsh installation. export ZSH="$HOME/.oh-my-zsh" export ZSH_CUSTOM="$HOME/.oh-my-zsh/custom" # Set name of the theme to load --- if set to "random", it will # load a random theme each time oh-my-zsh is loaded, in which case, # to know which specific one was loaded, run: echo $RANDOM_THEME # See https://github.com/robbyrussell/oh-my-zsh/wiki/Themes # ZSH_THEME="spaceship" # I'm using starhip (see below, where it's configured) # Set list of themes to pick from when loading at random # Setting this variable when ZSH_THEME=random will cause zsh to load # a theme from this variable instead of looking in ~/.oh-my-zsh/themes/ # If set to an empty array, this variable will have no effect. # ZSH_THEME_RANDOM_CANDIDATES=( "robbyrussell" "agnoster" ) # Uncomment the following line to use case-sensitive completion. # CASE_SENSITIVE="true" # Uncomment the following line to use hyphen-insensitive completion. # Case-sensitive completion must be off. _ and - will be interchangeable. HYPHEN_INSENSITIVE="true" # Uncomment the following line to disable bi-weekly auto-update checks. # DISABLE_AUTO_UPDATE="true" # Uncomment the following line to automatically update without prompting. # DISABLE_UPDATE_PROMPT="true" # Uncomment the following line to change how often to auto-update (in days). export UPDATE_ZSH_DAYS=8 # Uncomment the following line if pasting URLs and other text is messed up. # DISABLE_MAGIC_FUNCTIONS=true # Uncomment the following line to disable colors in ls. # DISABLE_LS_COLORS="true" # Uncomment the following line to disable auto-setting terminal title. # DISABLE_AUTO_TITLE="true" # Uncomment the following line to enable command auto-correction. ENABLE_CORRECTION="true" # Uncomment the following line to display red dots whilst waiting for completion. COMPLETION_WAITING_DOTS="true" # Uncomment the following line if you want to disable marking untracked files # under VCS as dirty. This makes repository status check for large repositories # much, much faster. # DISABLE_UNTRACKED_FILES_DIRTY="true" # Uncomment the following line if you want to change the command execution time # stamp shown in the history command output. # You can set one of the optional three formats: # "mm/dd/yyyy"|"dd.mm.yyyy"|"yyyy-mm-dd" # or set a custom format using the strftime function format specifications, # see 'man strftime' for details. HIST_STAMPS="mm/dd/yyyy" # Would you like to use another custom folder than $ZSH/custom? # ZSH_CUSTOM=/path/to/new-custom-folder # Which plugins would you like to load? # Standard plugins can be found in ~/.oh-my-zsh/plugins/* # Custom plugins may be added to ~/.oh-my-zsh/custom/plugins/ # Example format: plugins=(rails git textmate ruby lighthouse) # Add wisely, as too many plugins slow down shell startup. plugins=( aws # sets up `awscli` tab completion + profile changing commands alias-tips # let's you know when you have an alias you can use autojump # use j to jump to directories containing terms. Directories must be visited first before they can be jumped to. autoupdate # automatically updates custom plugins common-aliases # add tons of aliases like la ll etc git-auto-fetch # automatically "fetches" for new changes of directory you're in git-extras # adds a bunch of helpful git aliases and extra commands gitfast # adds git tab completion git-flow # adds completion for git flow commands node # adds completion for node npm # adds completion/aliases for npm zsh-autosuggestions # adds suggestions as you type zsh-interactive-cd # cd + tab to fuzzy search navigate zsh_reload # adds `src` command for better full compile reload ) # Load Oh My ZSH source $ZSH/oh-my-zsh.sh # autojump config [[ -s $HOME/.autojump/etc/profile.d/autojump.sh ]] && source $HOME/.autojump/etc/profile.d/autojump.sh autoload -U compinit && compinit -u # FZF config export FZF_BASE=~/.fzf export PATH="/usr/local/sbin:$PATH" [ -f ~/.fzf.zsh ] && source ~/.fzf.zsh # zsh-syntax-highlighting source /usr/local/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh # broot source $HOME/.config/broot/launcher/bash/br # User configuration export MANPATH="/usr/local/man:$MANPATH" # You may need to manually set your language environment # export LANG=en_US.UTF-8 # Preferred editor for local and remote sessions if [[ -n $SSH_CONNECTION ]]; then export EDITOR='code' else export EDITOR='code' fi # Compilation flags # export ARCHFLAGS="-arch x86_64" # Set personal aliases, overriding those provided by oh-my-zsh libs, # plugins, and themes. Aliases can be placed here, though oh-my-zsh # users are encouraged to define aliases within the ZSH_CUSTOM folder. # For a full list of active aliases, run `alias`. # # Example aliases alias zshconfig="code ~/.zshrc" alias ohmyzsh="code ~/.oh-my-zsh" alias reload="source ~/.zshrc" # My Custom Aliases change alias please="sudo !!" alias tmp="cd ~/Development/tmp" alias proj="cd ~/Projects" alias work="cd ~/Work" alias co.="code ." ### CFG Setup # Alias for the main cfg git # alias cfg='/usr/bin/git --git-dir=$HOME/.cfg/ --work-tree=$HOME' # export function cfg { # /usr/bin/git --git-dir=$HOME/.cfg/ --work-tree=$HOME $@ # } # lastly init starship theme eval "$(starship init zsh)"

#!/bin/ksh # https://github.com/robbyrussell/oh-my-zsh/blob/master/plugins/cp/ # Also mentioned on Reddit as a nicer copy command. # # RSYNC OPTIONS: # -b, --backup make backups # --backup-dir=DIR # In combination with the --backup option, this tells rsync to # store all backups in the specified directory on the receiving # side. This can be used for incremental backups. You can also # specify a backup suffix using the --suffix option (otherwise # the files backed up in the specified directory will keep their # original filenames). # # -e, --rsh=COMMAND # This option allows you to choose an alternative remote shell # program to use for communication between the local and remote # copies of rsync. /dev/null disables remote shells, so this # only works on local files. # # -h, --human-readable output numbers in a human-readable format # -g, --group preserve group # -o, --owner preserve owner (super-user only) # -p, --perms preserve permissions # --progress show progress during transfer # -r, --recursive recurse into directories # -t, --times preserve modification times # -X, --xattrs preserve extended attributes # -x, --one-file-system avoid crossing filesystems when recursing export PATH=/usr/local/bin:/bin:/usr/bin tag=${0##*/} case "$#" in 0|1) echo "usage: $tag srcfile dest"; exit 1 ;; *) ;; esac exec rsync -pogbrtxX -hhh --backup-dir=/tmp/rsync -e /dev/null --progress "$@" exit 1

Zsh with Oh My Zsh. Oh My Zsh is a framework for managing zsh configuration.

And btw is this similar to https://github.com/robbyrussell/oh-my-zsh/blob/master/plugins/fzf/fzf.plugin.zsh ?

The reports often rank the issues by severity level and provide actionable solutions. Using these reports, developers can prioritize accessibility fixes and improve their products' accessibility. Popular examples of automated testing tools include Axe, WAVE, and SiteImprove. Also, most modern browsers offer built-in accessibility audits within their developer tools.

‌Videos To caption videos, HTML is a great option. But if you are using markdown, you can embed videos from YouTube and Vimeo using the tag. These apps offer in-built caption support so you can enable captions before adding the embed code.

You could also install third-party plugins for this purpose.

Here’s another tip: avoid flashing content in your videos as it could lead to seizure triggers. If your video has flashing bright colours, ensure that it does not exceed two times within a second.

Add transcripts to audios and videos

It’s a good idea to add transcripts to your audio and video content. Not everyone will want to watch or listen to the content. But they may be curious to know what it is about.

By adding a transcript, you make it easier for anyone to navigate through the content and get the information that they need.

Transcript for audio
For audio content, you can insert transcripts using HTML.

Here’s an example:

 controls muted> 
   src="ringtone.mp3" type="audio/mpeg"> 
 

 
  
Here is a transcription of the text 
  00:03 = I am going to be productive today

 
  00:05 = I am going to be productive today

 
  00:08 = I am going to be productive today

 
  00:10 = I need to be productive today

 
  00:11 = I have to be productive today

 
  00:13 = I should be productive today

 
  00:16 = I am going to be productive today

 
  00:18 = I ought to be productive today

 
  00:21 = I have to be productive today

 
  00:23 = Productivity matters to me 

 

Enter fullscreen mode Exit fullscreen mode

For markdown documentation sites like Docusaurus, you can create a custom component.‌

• In your src/components folder, create a file named transcript.jsx.

• Insert this code:
  

import React, { useState } from 'react'; 
export default function Transcript({ }) { 
  const [showTranscript, setShowTranscript] = useState(false); 
  const toggleTranscript = () => { 
    setShowTranscript(!showTranscript); 
  }; 
  return ( 
    <div> <a href="#" onClick={toggleTranscript}> { 
    showTranscript ? 'Hide transcript' : 'View transcript'
    } 
    </a> {showTranscript && ( 
 (insert your transcript text here) div> )} 
    </div> 
  ); 
}‌

Enter fullscreen mode Exit fullscreen mode

• Go to your markdown file and import it.

import Transcript from '@site/src/components/transcript'; 

Enter fullscreen mode Exit fullscreen mode

Note: I added some tweaks to the code to make transcript display optional. You can edit it if you want the transcript to show as the page loads.

Transcript for video
Now for videos, YouTube is a great option. It provides inbuilt transcripts for your videos. So, you can always embed YouTube videos in your docs.

The transcript is in the video description after the main details. The transcript will display with the timestamps when you click the “Show Transcript” button.

Add code snippets and use the colour contrast technique

How to add code snippets
Use code blocks within the text to explain code instead of images. You could also use code snippets to showcase the output of your code. Unless it is necessary to add an image, you should use code snippets.

For instance,

index.html

 
   
    
     
    A calculator app 
     
    
    
    
  

Enter fullscreen mode Exit fullscreen mode

This will allow screen readers to read through the code, which they are not able to do with screenshots.

Colour contrast technique
The colour contrast technique implies using colours that are opposite or heavily contrasting.

For example, using black text on a white background has a high contrast, as opposed to using light brown text on a brown background.

When combining colours, you could use an accessible colour palette like Color Safe.‌

Add translation options

There are documentation sites that provide translation options where you can build your docs in multiple languages, websites like Jekyll. This is an example.

Docusaurus is also another doc site that provides multilingual options using Crowdin or Git.

• Follow through this guide to set up translation and localization on Docusaurus using Git.

• Follow through this guide to set up translation and localization on Docusaurus using Crowdin.‌

Use accessibility testing tools

There are tools you can use to check for errors in accessibility in your docs. Some examples are WAVE (Web Accessibility Evaluation Tool) and AXE (Accessibility Engine).

Also, you can get the NVDA(NonVisual Desktop Access) screen reader to test out your content. This software will let you know how the content of your documentation will be perceived by a user using a screen reader.‌

Set up an improvement or suggestion box

Finally, it may not be possible to cover the needs of every user. So you could add a suggestion or improvement box, allowing users to send feedback about how you could further improve the content. Hearing firsthand from users can help you know how best to make the docs accessible for them.

To add an improvement box, you could use an external form link that stores the users’ inputs or you could set up the suggestion box in the docs.

How to add an external form link in Docusaurus

You would need to create a custom component for that.

• Go to src/components folder and create a file feedback.jsx.

• Add this code:
  

import React from 'react'; 

export default function FeedbackButton({ href }) {
  return ( <a href={href} target="_blank" rel="noopener noreferrer" > Give Feedback </a> ); 
}; 

Enter fullscreen mode Exit fullscreen mode

• In your markdown file import it:

import FeedbackButton from '@site/src/components/feedbackbutton';

Enter fullscreen mode Exit fullscreen mode

• Insert the link

Enter fullscreen mode Exit fullscreen mode

When you run it on your docs, it should showcase a link to Google forms. Google Forms is an example, you could add the link to your company website or server.

Here’s what it’ll look like:

Summary

To follow and implement these accessibility best practices, you can consider creating or using an already made style guide. This can help you consistently implement these practices and make it easier for you and other technical writers on your team.

There are style guides focused on accessibility for technical writers, such as the following:

• Accessibility style guide by Heyawhite

• Write accessible documentation by Google for developers

• Writing for Accessibility by MailChimp content style guide

That sums up my tips about web accessibility practices in writing. I’m a technical writer, and you can reach out to me on Instagram or hire me via Upwork. Thank you for reading.‌

To measure or rather estimate accessibility, we can use automated audits like WAVE, axe and the accessibility report in Lighthouse or PageSpeed Insights to ensure that we don't violate essential Web Content Accessibility Guidelines (WCAG)

axe-core licensed via MPL 2.0: https://github.com/dequelabs/axe-core

Here is the BrowserStack extension:

[ ] Checked with axe DevTools and addressed Critical and Serious issues?

axe-core - To detect violations on page level.

Like auditing WCAG compliance with accessibility tools like axe and WAVE, it has become much easier to measure and provide data about the ecological impact of web development, but there are still a lot of unknown figures.

Axe is a set of tools created by Deque, to provide a solution for a testing library. To use Axe, one of the possible ways is to install Axe DevTools, which is a browser extension that provides you with a way to test your applications for accessibility issues. To start testing for accessibility using Axe DevTools, you just open the browser's Developer Tools, navigate to the Axe DevTools tab, and run an analysis on your desired webpage;