Setup linter for HTML/CSS & Cleanup website,

[Carreau]

While reviewing the great work of @charnpreetsingh185, @spoorthyv and @faricacarroll in #103 I realize that the current website is not using a lot of best practices and does many things wrong (62 w3c validation error on the index page) . So we are building things on quicksand.

It would be nice to spend some cycle cleaning this up. It's not lost time it will make everyone work simpler as the bad HTML and CSS will introduce unexpected rendering problem and complexity in writing correct CSS> .

@willingc can you try to manage part of that ? I know that Brian

[willingc]

@Carreau Thanks for reviewing the interns work :D They are really dedicated ☀️

I agree it would be good to spend some cycles on clean up. Let's see if we can break down the clean up into a plan with concrete steps. This would simplify tracking and execution by all of us.

Plan

• Identify tool(s) to be used for validation
  • https://validator.w3.org/nu/about.html as you suggested in your link
  • https://github.com/svenkreiss/html5validator recommended by the above for testing on Travis (which would make sense since this repo has less traffic than notebook repo)
    • this one we would need to setup a jekyll build on travis first.
• Determine the best order to address errors and warnings
  • Errors (Currently, 51 errors)
  • Warnings (Currently, 11 warnings)
• Correct errors by error type (It looks like there are 3 categories)
  • An img element must have an alt attribute, except under certain conditions.
  • Duplicate ID tab.
  • Element ___ not allowed as child of element ___ in this context.

• Correct warning type (4 categories of warnings found)

Matthias, Let's decide on the tool(s) and I'm assuming it's better to fix errors before warnings. Once you and I decide on the tool(s) for validation, we can assign the interns a subset of errors. What do you think?

[Carreau]

We should likely have a css linter as well, I also edited above to add that if we want to test on travis, we need to setup a build on Travis.

[willingc]

Any suggestions on a css linter? Any thoughts on setting up Travis before or after all the changes?

[willingc]

Travis is up and running! 🎉

Summary of work still to be done

HTML errors and warnings to be corrected

• Duplicate ID tab.
• Element ___ not allowed as child of element ___ in this context.
  
• Correct warning type (4 categories of warnings found)

CSS warnings to be corrected

• Warnings as reported by CSSLint on Travis.