summaryrefslogtreecommitdiff
path: root/docs/guide/coding-standards
AgeCommit message (Collapse)AuthorFilesLines
2021-03-22Update text wrapping in documentationDerick Montague2-15/+53
To meet best practices and standards for markdown, this commit updates all markdown files used for the VuePress documentation so that each line is limited to 80 characters. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I0cadb33343ce1bc331dfefd096d8137a04c33604
2021-02-26Update coding standards documentationDerick Montague3-3/+1
- Remove pages without content - Update overview page name Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Icf26e65d72d2900ddbe216be974930bcc9c0e196
2020-10-27Add coding standards overview pageDerick Montague1-0/+23
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I2dd0fb44a78da62864442fd633654a3e4f887184
2020-10-26Remove blank overview pages in documentationDixsie Wolmers1-1/+0
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: I6238767b89eda7e0aaebe73faa2ca3e0a61ebf5e
2020-10-20Add narrator to screen reader listDerick Montague1-2/+3
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I4399271998fca392f457d0d1769f1e9337881f44
2020-06-28Update accessibility documentationDerick Montague1-1/+2
- Update IBM Accessibility resources link text - Add IBM Accessibility tools link to tools section Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I602a0f44464ccb373069d37b0313a89ad6311149
2020-05-15Add themes documentationDerick Montague2-1/+1
- Renamed all index.md to readme.md to make consuming the documentation from the Github repo easier. VuePress treats index.md and readme.md the same way when building the static pages. - Added theme section overview documentation - Added how to customize documentation - Added custom style imports to support OpenBMC Web UI component documentation to remove Bootstrap framework base styles that conflict with the Vuepress theme - Found occurrences of the word Sass in upper-case and changed to use sentence case. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: If5588f88a3d75761cc47e85a3fb0a582b31d373c
2020-03-12Add accessibility documentationDerick Montague1-1/+43
Create resources and guidance for the accessibility needs of the OpenBMC Web UI. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I6d63ce2e23e403840cfb263622c0bd3dac906abd
2020-02-08Add coding guidelines and component documentationDerick Montague4-0/+4
Resubmitting after reverted–original commit here https://gerrit.openbmc-project.xyz/c/openbmc/webui-vue/+/28760 - Update README to include instructions on documentation development - Update vue and vue-template-compiler to be compatible with vuepress Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I72049a5888ef6bea6621d0b7948f57a8e4177666
2020-01-29Revert "Add coding guidelines and component documentation"Gunnar Mills4-4/+0
Merged accidentally. Did not have proper +1s/+2s. The author will resubmit. Apologies for the noise. This reverts commit aae4312c3c535253b2d5db7a75503f0237ae423e. Change-Id: I110dd4e12286836aedf84dfba2c4ef07cac08b46 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2020-01-29Add coding guidelines and component documentationDerick Montague4-0/+4
- Add deploy script to create and deploy dist file to gh-pages branch - Update README to include instructions on documentation development and deployment - Update vue and vue-template-compiler to be compatible with vuepress - Set vue-date-fns to use specific version - Add shell pages to be completed later Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I2fdae06d53c298d45f7a638e8875717a47050dbf