Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gsa/openacr-website
Beta site for OpenACR (previously Open Product Accessibility Template or OPAT) - https://github.com/GSA/openacr
https://github.com/gsa/openacr-website
accessibility acr documentation government section508 vpat
Last synced: about 2 months ago
JSON representation
Beta site for OpenACR (previously Open Product Accessibility Template or OPAT) - https://github.com/GSA/openacr
- Host: GitHub
- URL: https://github.com/gsa/openacr-website
- Owner: GSA
- License: other
- Created: 2021-07-06T20:15:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-01T09:57:10.000Z (over 1 year ago)
- Last Synced: 2024-06-11T19:27:19.948Z (7 months ago)
- Topics: accessibility, acr, documentation, government, section508, vpat
- Language: JavaScript
- Homepage:
- Size: 8.79 MB
- Stars: 3
- Watchers: 6
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# OpenACR Website
This is the website for the [OpenACR](https://github.com/GSA/openacr) (previously known as Open Product Accessibility Template or OPAT). OpenACR is an machine-readable Accessibility Conformance Report (ACR). The goal of this site is to host a description fo the format and instructions on how to use it.
A [preview of the site](https://federalist-6d3494a6-5b03-42fa-82f2-57f3bbb203af.app.cloud.gov/site/gsa/openacr-website/) is now available.
The site is built with Jekyll using the U.S. Web Design System (USWDS) framework. It is hosted on Federalist, but using this GitHub repository you can install it locally. We have included more information from the default [Federalist implementation of the USWDS](https://github.com/18F/federalist-uswds-jekyll) to help get folks started.
## Federalist + U.S. Web Design System + Jekyll
This [Jekyll theme](https://jekyllrb.com/docs/themes/) is developed using the [U.S. Web Design System v 2.0](https://v2.designsystem.digital.gov) and is focused on providing developers a starter kit and reference implementation for Federalist websites.
This code uses the [Jekyll](https://jekyllrb.com) site engine and built with Ruby. If you prefer to use Javascript, check out [federalist-uswds-gatsby](https://github.com/18F/federalist-uswds-gatsby), which uses [Gatsby](https://gatsbyjs.org) site engine.
This project strives to be compliant with requirements set by [21st Century IDEA Act](https://www.meritalk.com/articles/senate-passes-idea-act/). The standards require that a website or digital service:
- is accessible to individuals with disabilities;
- has a consistent appearance;
- does not duplicate any legacy websites (the legislation also requires agencies to ensure that legacy websites are regularly reviewed, removed, and consolidated);
- has a search function;
- uses an industry standard secure connection;
- “is designed around user needs with data-driven analysis influencing management and development decisions, using qualitative and quantitative data to determine user goals, needs, and behaviors, and continually test the website, web-based form, web-based application, or digital service to ensure that user needs are addressed;”
- allows for user customization; and
- is mobile-friendly.
### How to edit
- Non-developers should focus on editing markdown content in the `_posts` and `_pages` folder
- We try to keep configuration options to a minimum so you can easily change functionality. You should review `_config.yml` to see the options that are available to you. There are a few values on top that you **need** to change. They refer to the agency name and contact information. The rest of `_config.yml` has a range of more advanced options.
- The contents inside `assets/` folder store your Javascript, SCSS/CSS, images, and other media assets are managed by [jekyll-assets](https://github.com/envygeeks/jekyll-assets). Assets are combined, compressed, and automatically available in your theme
- If you look at `package.json` you will see that the `npm run federalist` command that will run when running on the Federalist platform.
- Do not edit files in the `_site/` folder. These files are auto-generated, and any change you make in the folder will be overwritten.
- To edit the look and feel of the site, you need to edit files in `_includes/` folder, which render key components, like the menu, side navigation, and logos.
- `index.html` may not require much editing, depending on how you customize `hero.html` and `highlights.html`.
- `_layouts/` may require the least amount of editing of all the files since they are primarily responsible for printing the content.
- `blog/index.html` can be edited, but be careful. It will impact the pagination system for the posts. If you do edit the file, be prepared to edit `_config.yml`. For example, you may need go change configurations for [jekyll-paginate-v2](https://github.com/sverrirs/jekyll-paginate-v2)
- `search/index.html` is used by search.gov.
### Getting Started
#### With `npx` (requires node)
$ npx degit https://github.com/GSA/openacr-website#main
$ cd
#### Push to your Github repository
- [Create a new Github repository](https://help.github.com/en/github/getting-started-with-github/create-a-repo).
- Follow the instructions form Github or
```
$ git init
$ git symbolic-ref HEAD refs/heads/main
$ git add . && git commit -m 'Initial commit'
$ git remote add origin [email protected]:/.git
(Make sure to replace `` and `` above with the correct values)
$ git push -u origin main
```
### Installation for development
$ git clone https://github.com/GSA/openacr-website.git
$ cd openacr-website
### Running the application
#### With locally installed `node` and `ruby`
$ npm install
$ bundle install
$ npm start
OR
$ bundle exec jekyll serve
To build but not serve the site, run `npm run build` or `bundle exec jekyll build`.
#### With Docker
$ docker-compose run node npm install
$ docker-compose build
$ docker-compose up
To build but not serve the site, run:
```
docker-compose run ruby bundle exec jekyll build
```
.
Note that when built by Federalist, `npm run federalist` is used instead of
`npm run build`.
Open your web browser to [localhost:4000](http://localhost:4000/) to view your
site.
### Testing
#### With locally installed `node` and `ruby`
$ npm test
OR
$ bundle exec htmlproofer _site; npx a11y '_site/**/*.html'
#### With Docker
$ docker-compose run ruby bundle exec htmlproofer _site; npx a11y '_site/**/*.html'
## Technologies you should be familiarize yourself with
- [Jekyll](https://jekyllrb.com/docs/) - The primary site engine that builds your code and content.
- [Front Matter](https://jekyllrb.com/docs/frontmatter) - The top of each page/post includes keywords within `--` tags. This is meta data that helps Jekyll build the site, but you can also use it to pass custom variables.
- [U.S. Web Design System v 2.0](https://v2.designsystem.digital.gov)
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md) for additional information.
## Public domain
This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):
> This project is in the public domain within the United States, and copyright
> and related rights in the work worldwide are waived through the [CC0 1.0
> Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
>
> All contributions to this project will be released under the CC0 dedication.
> By submitting a pull request, you are agreeing to comply with this waiver of
> copyright interest.