chef / chef/chef-web-docs

Refresh Tables in Docs

Open
#2,854 0 comments 0 reactions 1 assignee View on GitHub

@dishanktiwari2501 is already working on this.

Since Jan 21, 2021.

Aspect: Documentation Type: Docs Debt
Dominant language
HTML
Stars
143
Forks
438
Avg merge
1d 10h
Merged PRs (30d)
16

Description

User Story

As a Chef user, I expect docs content to be accessible and responsive

Description

Our tables are one of the things that make our docs inaccessible.
They're also kindof a mess in terms of structure (HTML vs Markdown tables) content and reuse.

Proposed Refresh steps:

#. Inventory tables. Census of styles. Which tables are--or should be--reused? Which tables need moved into another style of table?
#. Create SASS styles for table styles
#. Find out if we can apply classes to markdown tables
#. Find out if we can use markdown tables from inside of partials
#. Find out if markdown tables w/classes meet accessibility standards
#. Find out if we can do complex or irregular tables in markdown
#. Reformat tables accordingly

Starter-pack of resources (feel free to add more)
Table accessibility standards: https://www.w3.org/WAI/tutorials/tables/
On applying classes to markdowntables: https://stackoverflow.com/questions/14732028/add-id-or-class-to-markdown-element
Responsive tables: https://css-tricks.com/under-engineered-responsive-tables/
Goldmark Markdown: https://github.com/yuin/goldmark

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.