Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Jekyll for the website #10

Merged
merged 75 commits into from Aug 5, 2016
Merged

Conversation

WilcoFiers
Copy link
Member

@WilcoFiers WilcoFiers commented Jul 30, 2016

Edit: I've put an implementation of this site on http://wilcofiers.github.io/auto-wcag/

Firstly, there are a LOT of changes. This was quite a lot of work that was way over due. Important to know is that None of the text in the rules or drafts have been changed. Only the markup was touched, and the occasional typo. This should make reviewing easier.

Next, I don't want to maintain our own static site generator. So I've adopted one that I thought fit our needs best, which is Jekyll. For more info, see: https://jekyllrb.com/

Summary of all the changes:

  • Deleted node_modules and package.json, as well as the build directory
  • Included Jekyll _config.yml and _layout stuff
  • Put a table with all rules on the homepage, and added a drafts page with a similar table of all drafts.
  • All pages are now part of the website's navigation
  • Added a footer
  • Restructured the rule-design document. It now follows the same structure as the template.
  • Changed 'test method' back to 'test mode' (an earlier change that was incorrect)
  • Moved all the rules from 'rules' to '_rules' and 'drafts' to '_drafts' (required for Jekyll)
  • Added 'authors' property to every rule. I want contributors to have credit for their work.
  • Added a contributors.yml file, which should hold the details about our contributors. We don't want to put that data in the rule files as it would mean duplicating that data
  • Created a criteria.json to hold the details of all WCAG criteria.
  • Renamed the outdated directory to early-stage.

I've also updated the formatting of the rules and drafts:

  • All the wiki markup is now replaced by markdown. Much of it was so already but there were a few stragglers.
  • YAML front matters https://jekyllrb.com/docs/frontmatter/ is used for rule properties. This let's us create the table on the home page as well
  • Use of empty lines is used consistently throughout
  • Algorithms have been copied to the pages/algorithms directory
  • All links to local files now point to .html files.
  • Made sure all (most?) element and attribute references are in back ticks (so img elements instead of <img> elements)
  • Adjusted all internal links to steps and such
  • Updated all notes to be consistent
  • Changed some of the testcase and ID values to use variables (e.g.: SC312-text-fail1 to {{ page.rule_id }}-fail1.

@WilcoFiers WilcoFiers merged commit d567580 into act-rules:master Aug 5, 2016
jeeyyy added a commit that referenced this pull request Oct 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant