Coder Social home page Coder Social logo

gctools-outilsgc / aurora-website Goto Github PK

View Code? Open in Web Editor NEW
16.0 16.0 9.0 42.28 MB

Aurora is a central design system for all products and applications for the Open, Accessible Digital Workspace. This repo is for all code and issues related to the Aurora documentation website.

Home Page: https://design.gccollab.ca/

License: MIT License

JavaScript 73.06% CSS 26.94%

aurora-website's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

aurora-website's Issues

Merge all relevant branches into the master

In order to migrate things into the gatsby v1 version that works with IE I need all the changes/branches to be added to the master. At the moment the master is not the deployable version found in the gh-pages branch.

Current branches that need to be reviewed or finalized and submitted as pull requests:

  • final-style
  • french-documentation
  • tables
  • jsxify-nav
  • dropdownButtonState
  • features (branch removed)

Linting

Make sure all code that is already written passes the linter test.

Configuration on Codacy.

Nav not completely accessible on mobile

Originally created by Rick Massie on Sept. 25

The NAV menu is missing the last menu item, but there is no indication to scroll left. A sighted user would have no idea it exists. It would be good to jump to a hamburger menu when the NAV expands beyond the device width.

image

Increase padding to make it cut off the screen.

Anchor links and Menu Nav issue

Originally created by Rick Massie on Sept. 18

When creating an anchor link, the page jumps to the correct anchor.

However, the anchor ends up being hidden underneath the top nav menu. I'm not sure exactly what is happening, but somehow the Nav menu seems to be "floating" above the rest of the content, and since the browser bring anchor links to the top of the content area, it actually ends up hidden under the nav menu.

Accessibility Testing with CI

Integrate accessibility testing with continuous integration software tool.

Ressources/Solutions:

  • TravisCI
  • Jenkins
  • CircleCI

Create usability test for Aurora website

Once launched, the Aurora website should undergo a usability test to ensure efficient navigation and task completion by key users. A test will need to be designed an planned to ensure we meet our goals for usability.

Table sample does not have title

Originally created by Rick Massie on Sept. 25

The text on the table page says tables should have informative.titles, but the examples do not have titles. Would be good to demonstrate it in the examples.

Create Future improvements page

Gen asked for a page outlining planned improvements to the Aurora design system, based on versions. This information is to be added prior to communications is sent.

English content for this page is written. When translation is completed, a new page will need to be created in both EN and FR and deployed to the site.

voice and tone documentation

addressing users, referring to product creators (GCtools), referring to Government of Canada, validation messages (positive, neutral and negative), localization/translation, active voice, calls-to-action

To be completed after A/B testing on voice and tone.

To be included in the branding package, and design system at a later date.

Overall changes to components pages

Some updates are required on all components pages:

  • Skip over code block elements
  • Look for replicated IDs
  • Consider adding more context to page titles

Card page updates

Cards page needs updates:

  • Review headings in the Components of Card section

Add to documentation on Search page

Documentation should include guidelines on when to use magnifying glass icon or not.

Icon - when completing a query leads to a new search results page
No icon - for auto-complete search results

Custom URL on Github Pages

When a name for the design system is decided, change the url to match the name and make the correction needed for pathing to work with the new url.

Add do and don't images to documentation, with text

When Aurora website is complete, add do and don't images to documentation with text and consistent style. A custom component for the do/don't text style will need to be created.

Custom component and respective images + text will need to be added to corresponding article.

Changes to button inputs

Button inputs page needs updates for accessibility:

  • Review component examples (switch esp.)
  • Checkbox examples
  • Badges need black text (#96A8B2)

Updates to form design and labels page

Form design and labels needs updates:

  • Submit button is in French on the English page
  • File upload needs to match component in the design system
  • Components do not match design specifications
  • French, change "Email" label to "Courriel"
  • Microcopy text may be a colour contrast issues
  • Review radio buttons

User testing for system voice and tone

Conduct user testing for preferred tone on the new GCtools/OADW platforms. Will help determine writing style within applications (i.e. micro-copy, alerts etc.)

Will be conducted using multi-variant testing.

Compare FR and EN documentation and update FR articles

Several changes were made to EN documentation during reviews. French documentation will need to be compared and matched to corresponding EN articles.

  • Add helmet tag to all articles
  • Add hex code pills to

Overview

  • Add images to Blogues

Content

  • Content Guidelines missing section in FR
  • Typographie needs do/don't for emphasis (with translation)
  • Back to top needs FR wb component
  • Missing Progress Indicators article in FR (with translation)

Data

  • In Data Overview need FR version of Illustrator images
  • Add images to Choosing visualizations
  • Add images to column and bar graphs
  • Add component images in Legends and Tooltips
  • Add image to Scatterplots
  • Need French images for interactive Tables
  • Add images to Line Graphs

Create download page

Design and develop download page with option to download either the UI kit or the Aurora CSS file.

General review of data section

Some review changes apply to multiple pages:

  • Table components need titles
  • Review accessibility of tables
  • Table scope to identify cells
  • Verify if components are actually built, if so, add them to pages

Customize Error Box component

Error Box component currently on Aurora doesn't match our design specifications in UI kit and documentation.

Customize this component to match.

Language Switching

Find how best to implement language switching/i18n in a react based app/static site.

Possible solutions:

  • Hold the text in data files to be switched when required.
  • Create a copy of the site in french.

Resources:

  • Luc Belliveau implemented a version of i18n for our react tools in the gctools-component repo.
  • The digital playbook hosts a static site with language switching using the WET component.

Additional queries:

  • Do sections in the url paths need to change to reflect the change in language?
Maple.com/en/Components/buttons/ 
Maple.com/fr/Composants/buttons/
  • Does the application need to detect the locale of the user and direct the user to the correct front page?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.