From da055b836631d25dec402c37eef87eddbc132416 Mon Sep 17 00:00:00 2001 From: Minghua Sun Date: Fri, 19 Apr 2019 10:00:20 -0400 Subject: [PATCH] Update Mayflower docs homepage (#541) * initial commit * edit * add calcualtors * create community project page * move into docs * add to menu * Added stuff Fixed a row with MassDEP info, added the DTC form release search application, and added the EEC salesforce application. @avrilpearl @clairesunstudio , can you confirm that we do want the EEC in there and that I wrote the right things for the different columns for that row? * community edits changed things in the table, removed the community projects table, added a join our community section, updated the submit your project bullets, tried to reference headings in getting started section. * Update docs/README.md --- docs/README.md | 44 ++++++++++++++++++++++++++------------ docs/SUMMARY.md | 1 + docs/community-projects.md | 14 ++++++++++++ 3 files changed, 45 insertions(+), 14 deletions(-) create mode 100644 docs/community-projects.md diff --git a/docs/README.md b/docs/README.md index 341a433675..0ab27079a2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,29 +5,45 @@ The goals of Mayflower are: * To create a consistent, inclusive user experience and look and feel across the Commonwealth’s discrete and diverse digital ecosystem for the constituents. -* To allow Digital Services team and its customers efficiently design and build accessible, mobile-friendly and consistent web products using Mayflower as a unified design system. +* To allow Commonwealth agencies to efficiently design and build accessible, mobile-friendly and consistent web products using Mayflower as a unified design system. ## Implementations +[Massachusetts Digital Service](https://www.mass.gov/orgs/digital-services) has implemented Mayflower for the following projects. Use the table below to browse the projects, learn more about their technology stack, and get ideas for your Mayflower implementation. + | Name | Distribution | Author/Maintainer | Notes | | :--- | :--- | :--- | :--- | -| [**Mass.gov**](https://mass.gov) | Drupal | [EOTSS Digital Services Team](https://www.mass.gov/orgs/digital-services) | Mayflower Patternlab | -| [**Search.mass.gov**](https://search.mass.gov) | React + S3 | [EOTSS Digital Services Team](https://www.mass.gov/orgs/digital-services) | Mayflower React | -| [**RideShare Report**](https://www.mass.gov/rideshare) | React + S3 | [EOTSS Digital Services Team](https://www.mass.gov/orgs/digital-services) | Mayflower React | -| [**Public Water Doc Search**](https://massgov.github.io/MassDEP/brp/dwp/pws-documents-search/build/%20) | React + Github Pages | MassDEP | Mayflower artifacts | -| [**RMV ATLAS**](https://atlas-myrmv.massdot.state.ma.us/myrmv/_/) | FAST proprietary | MassDOT | Mayflower inspired | -| [**MassDOT Open Data Portal**](https://geo-massdot.opendata.arcgis.com) | ArcGIS | MassDOT | Mayflower inspired | -| [**Civil Services Eligibility Lists (Entry level)**](https://www.mass.gov/service-details/civil-service-eligible-lists) | ASP.NET | ANF | Mayflower as markup | -| [**GIS Parcel Uploader**](https://uploads.massgis.digital.mass.gov/signup.html) | AWS S3 + Lambda + API Gateway | [EOTSS Digital Services Team](https://www.mass.gov/orgs/digital-services) | Mayflower as markup | -| [**DTC Form Release Search**](https://services.oca.state.ma.us/dtc/frmReleasedCalendar.aspx) | ASP.NET | DTC | Mayflower inspired | +| [**Mass.gov**](https://mass.gov) | Drupal | [EOTSS Digital Service](https://www.mass.gov/orgs/ma-digital-service) | [Mayflower Patternlab](/getting-started#mayflower-as-component-libraries) | +| [**Search.mass.gov**](https://search.mass.gov) | React + S3 | [EOTSS Digital Service](https://www.mass.gov/orgs/ma-digital-service) | [Mayflower React](/getting-started#mayflower-as-component-libraries) | +| [**RideShare Report**](https://www.mass.gov/rideshare) | React + S3 | [EOTSS Digital Service](https://www.mass.gov/orgs/ma-digital-service) | [Mayflower React](/getting-started#mayflower-as-component-libraries) | +| [**PFML Contribution Calculator**](https://calculator.digital.mass.gov/pfml/contribution/), [**PFML Benefits Calculator**](https://calculator.digital.mass.gov/pfml/yourbenefits) | React + S3 | [EOTSS Digital Service](https://www.mass.gov/orgs/ma-digital-service) | [Mayflower React](/getting-started#mayflower-as-component-libraries) | +| [**GIS Parcel Uploader**](https://uploads.massgis.digital.mass.gov/signup.html) | AWS S3 + Lambda + API Gateway | [EOTSS Digital Service](https://www.mass.gov/orgs/ma-digital-service) | [Mayflower as markup](/getting-started#mayflower-as-markup) | + + +## Become part of the community + +The Mayflower Design System is meant to be an active collaborative community of government developers, designers, and Mayflower enthusiasts, which is currently maintained by Massachusetts Digital Service. +If you want to join the Mayflower community, have questions about Mayflower, or are running into issues when implementing Mayflower, contact us! + +* [Join our Slack group to:](https://mayflowerdesignsystem.slack.com/join/shared_invite/enQtNTc0MjMwMjcwMzU0LWRkNGEzZjNiNjEwNDZlOWYxZWRmYTY0NWIxOTNkZTA3NzNhN2U5OTk0OGUzYjE4NjhhNDRiNDhhOGJmZDBjNTM) + * Reach the team + * Stay up to date on Mayflower releases + * Engage with community members +* [Ask a question on Github](https://github.com/massgov/mayflower/issues/new) #### Submit your project -If you have a new implementation to add to this list, please [open an issue](https://github.com/massgov/mayflower/issues/new?assignees=&labels=doc&template=add-a-mayflower-project.md&title=) with the following information: +If you’ve been using Mayflower to make changes to your application and want to share your work with others and/or ask the Massachusetts Digital Service team for design and implementation feedback, submit your project by [opening an issue](https://github.com/massgov/mayflower/issues/new?assignees=&labels=doc&template=add-a-mayflower-project.md&title=) with the following information: + +* A link to the application +* Your name or alias and contact URL or email address * The implementation’s target language and/or framework -* The code repository if it is in Github or it is public -* The author’s name or alias and contact URL or email address -* The most recent version of the Mayflower Design System that the project targets +* The code repository if it is in Github or equivalent (if public) +* What type of Mayflower implementation you are using +* What Mayflower Design System version you are using * Any useful caveats or other notes + + +We've looked around and have found [7 community projects](community-projects.md) that have used Mayflower inspiration for the design elements. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ce77681043..bd0d7ef4ee 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -50,4 +50,5 @@ * [Header](components/organisms/header.md) * [Footer](components/organisms/footer.md) * [Contribution](contribution.md) +* [Community Projects](community-projects.md) diff --git a/docs/community-projects.md b/docs/community-projects.md new file mode 100644 index 0000000000..da4781fba5 --- /dev/null +++ b/docs/community-projects.md @@ -0,0 +1,14 @@ +Community Projects +========================= + +Community Projects that are inspired by Mayflower: + +| Name | Distribution | Author/Maintainer | Notes | +| :--- | :--- | :--- | :--- | +| [**DTC Form Release Search**](https://services.oca.state.ma.us/dtc/frmReleasedCalendar.aspx) | ASP.NET | DTC | Mayflower inspired | +| [**Civil Services Eligibility Lists (Entry level)**](https://www.mass.gov/service-details/civil-service-eligible-lists) | ASP.NET | ANF | Mayflower as markup | +| [**Public Water Doc Search**](https://massgov.github.io/MassDEP/brp/dwp/pws-documents-search/build/%20) | React + Github Pages | MassDEP | Mayflower artifacts | +| [**RMV ATLAS**](https://atlas-myrmv.massdot.state.ma.us/myrmv/_/) | FAST proprietary | MassDOT | Mayflower inspired | +| [**MassDOT Open Data Portal**](https://geo-massdot.opendata.arcgis.com) | ArcGIS | MassDOT | Mayflower inspired | +| [**DTC Form Release Search**](https://services.oca.state.ma.us/dtc/frmReleasedCalendar.aspx) | ASP.NET | DTC | Mayflower inspired | +| [**EEC Licensed Child Care Search**](https://eeclead.force.com/EEC_ChildCareSearch) | Salesforce proprietary | EEC | Mayflower inspired |