coats/README.md

41 lines
1.5 KiB
Markdown

# coats
Collection of scripts (coats) that improve open-stack developer browsing experience
## Current scripts
### FoxReplace.json
FoxReplace.json is text replacements configuration for
<https://addons.mozilla.org/en-GB/firefox/addon/foxreplace/> which would add
some extra coloring on build logs, making them easier to read. We plan to
convert this into a greasemonkey helper in the future to allow use from
multiple browsers.
<img alt=foxreplace-os-logs src=img/coats-log-highlight-example.png width=100%>
After you install Firefox extension you can either do an one-time import
of the configuration from <https://raw.githubusercontent.com/openstack/coats/master/coats/FoxReplace.json>
or configure it to re-download it when it changes.
### openstack_gerrit_zuul_status.user.js
**openstack_gerrit_zuul_status.user.js**: Provides the status of the current CI run on the OpenStack Gerrit in real time.
## Ideas for future scripts
- Link codesearch.openstack.org results directly to github.com
## Context search for Firefox
If you often have to search for pieces of OpenStack related code on various
websites you may find useful to use [Context Search Firefox extension](https://addons.mozilla.org/en-US/firefox/addon/contextual-search/) that
allows you to perform context searches. You can import the configuration from
``coats/searchEngines.json``
<img alt=coats-log-highlight-example src=img/coats-firefox-context-search.png width=100%>
## Contributing
Before you raise a CR, please run "tox" to perform a sanity check.