From a4bedcacef958269667af2b3473d7b27e4a2f0cc Mon Sep 17 00:00:00 2001 From: Tess Ferrandez Date: Thu, 22 Aug 2024 13:20:11 +0200 Subject: [PATCH] Fix page navigation (#1065) * fix navigation * fix links * move usability to non-functional requirements * fix links --- docs/.pages | 2 ++ docs/CI-CD/.pages | 6 ------ docs/{resources/templates => }/LICENSE | 0 .../README.md | 6 +++--- .../recommended-technologies.md | 8 -------- .../CONTRIBUTING.md => contributing.md} | 0 .../usability.md | 2 +- docs/resources/ms_icon.png | Bin 2323 -> 0 bytes docs/resources/templates/README.md | 17 ----------------- docs/user-interface-engineering/stability.md | 3 --- linkcheck.json | 3 ++- 11 files changed, 8 insertions(+), 39 deletions(-) delete mode 100644 docs/CI-CD/.pages rename docs/{resources/templates => }/LICENSE (100%) rename docs/{user-interface-engineering => UI-UX}/README.md (92%) rename docs/{user-interface-engineering => UI-UX}/recommended-technologies.md (98%) rename docs/{resources/templates/CONTRIBUTING.md => contributing.md} (100%) rename docs/{user-interface-engineering => non-functional-requirements}/usability.md (96%) delete mode 100644 docs/resources/ms_icon.png delete mode 100644 docs/resources/templates/README.md delete mode 100644 docs/user-interface-engineering/stability.md diff --git a/docs/.pages b/docs/.pages index 0c22b05719..36ed6455da 100644 --- a/docs/.pages +++ b/docs/.pages @@ -3,7 +3,9 @@ nav: - Engineering Fundamentals Checklist: engineering-fundamentals-checklist.md - The First Week of an ISE Project: the-first-week-of-an-ise-project.md - Who is ISE?: ISE.md + - Contributing: contributing.md - Agile Development: agile-development - Automated Testing: automated-testing - CI/CD: CI-CD - ... + - UI/UX: UI-UX diff --git a/docs/CI-CD/.pages b/docs/CI-CD/.pages deleted file mode 100644 index 1da2a21b0a..0000000000 --- a/docs/CI-CD/.pages +++ /dev/null @@ -1,6 +0,0 @@ -nav: - - Continuous Delivery: continuous-delivery - - Continuous Integration: continuous-integration - - DevSecOps: dev-sec-ops - - GitOps: gitops - - ... diff --git a/docs/resources/templates/LICENSE b/docs/LICENSE similarity index 100% rename from docs/resources/templates/LICENSE rename to docs/LICENSE diff --git a/docs/user-interface-engineering/README.md b/docs/UI-UX/README.md similarity index 92% rename from docs/user-interface-engineering/README.md rename to docs/UI-UX/README.md index 61be61ef7a..89aaa2931f 100644 --- a/docs/user-interface-engineering/README.md +++ b/docs/UI-UX/README.md @@ -12,10 +12,10 @@ Keep in mind that like all software, there is no "right way" to build a user int The state of web platform engineering is fast moving. There is no one-size-fits-all solution. For any team to be successful in building a UI, they need to have an understanding of the higher-level aspects of all UI project. -1. [**Accessibility**](../accessibility/README.md) - ensuring your application is usable and enjoyed by as many people as possible is at the heart of accessibility and inclusive design. -1. [**Usability**](./usability.md) - how effortless should it be for any given user to use the application? Do they need special training or a document to understand how to use it, or will it be intuitive? +1. [**Accessibility**](../non-functional-requirements/accessibility.md) - ensuring your application is usable and enjoyed by as many people as possible is at the heart of accessibility and inclusive design. +1. [**Usability**](../non-functional-requirements/usability.md) - how effortless should it be for any given user to use the application? Do they need special training or a document to understand how to use it, or will it be intuitive? 1. [**Maintainability**](../non-functional-requirements/maintainability.md) - is the application just a proof of concept to showcase an idea for future work, or will it be an MVP and act as the starting point for a larger, production-ready application? Sometimes you don't need React or any other framework. Sometimes you need React, but not all the bells and whistles from create-react-app. Understanding project maintainability requirements can simplify an engagement’s tooling needs significantly and let folks iterate without headaches. -1. [**Stability**](./stability.md) - what is the cost of adding a dependency? Is it actively stable/updated/maintained? If not, can you afford the tech debt (sometimes the answer can be yes!)? Could you get 90% of the way there without adding another dependency? +1. **Stability** - what is the cost of adding a dependency? Is it actively stable/updated/maintained? If not, can you afford the tech debt (sometimes the answer can be yes!)? Could you get 90% of the way there without adding another dependency? More information is available for each general guidance section in the corresponding pages. diff --git a/docs/user-interface-engineering/recommended-technologies.md b/docs/UI-UX/recommended-technologies.md similarity index 98% rename from docs/user-interface-engineering/recommended-technologies.md rename to docs/UI-UX/recommended-technologies.md index 1a2e9ddd0a..80e4ffa326 100644 --- a/docs/user-interface-engineering/recommended-technologies.md +++ b/docs/UI-UX/recommended-technologies.md @@ -48,11 +48,3 @@ npm init vite@latest my-app --template react-ts # npm 7.x npm init vite@latest my-app -- --template react-ts ``` - -## HTML/CSS/JS - -> Coming soon! - -## Web Components - -> Coming soon! diff --git a/docs/resources/templates/CONTRIBUTING.md b/docs/contributing.md similarity index 100% rename from docs/resources/templates/CONTRIBUTING.md rename to docs/contributing.md diff --git a/docs/user-interface-engineering/usability.md b/docs/non-functional-requirements/usability.md similarity index 96% rename from docs/user-interface-engineering/usability.md rename to docs/non-functional-requirements/usability.md index 64f20c7725..d5817c5f9f 100644 --- a/docs/user-interface-engineering/usability.md +++ b/docs/non-functional-requirements/usability.md @@ -2,7 +2,7 @@ Usability is a topic that is often used interchangeably with user experience (UX), but they are not the same thing. Usability is a subset of UX, focusing specifically on the ease of use and effectiveness of a product, i.e., it is the ease with which users can learn and use a product to achieve their goals. Usability is a key factor in determining the success of a product, as it directly impacts user satisfaction, productivity, and overall experience. A system that is difficult to use or understand can lead to frustration, errors, and ultimately, abandonment by users. -Closely coupled with usability and UX is the concept of accessibility, which you can read more about [here](../accessibility/README.md). +Closely coupled with usability and UX is the concept of [accessibility](./accessibility.md). ## Characteristics diff --git a/docs/resources/ms_icon.png b/docs/resources/ms_icon.png deleted file mode 100644 index dbfd434fc7cb6307acab0095cd97beb4f9491bdb..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2323 zcmeAS@N?(olHy`uVBq!ia0y~yU;;9k7&zE~)R&4Yzkn2Hfk$L90|U1(2s1Lwnj^u$ zz;V>m#WAE}&f9B-t7JkX+8)-oHD>Q|+2C>El#a^@z7p0vrKYb}xNbIf8!WxMHpY?5 zTib9uPx6kQGZ9`vuTC^p&QE9jUp|ZZJrB?Va>1YQ*`bG@|IOiFKi@WXEC2O3cMqR^ zcye|8{kTWh%I(iS?zf+L+xrfaU4eQ2x8Ig)XWUyWF?Xirp1N;eO78sImnFaM=GkvQ ziqiJ&J+julKds*GTsKhlz4AXrcC%;Nhvnpl_b@SJa{@gp#K0h+!oZ;5!NA}!fq|hx zfsuj15g1TSEDQ`RqY6gDVKhBZDPJtOyXs*%zj^!Yw;!Lbs@;*b{PW$Vez|Gy&P}&s z+w*+=;XgZn@e)y7T-X%3?a$-CkAG%tkKYC?7);7PpIyFQukh8M&o!pYE9*L=53tLn z?f+SIZylsmnECc+*}2b2H|=6Jzdds%Mup*-$@%oh>ks{ZRJLz^q%gy6(Zvi0qDHg) zXwf%X1< Coming soon! diff --git a/linkcheck.json b/linkcheck.json index 3623e7d711..0595733f38 100755 --- a/linkcheck.json +++ b/linkcheck.json @@ -67,7 +67,8 @@ "https://www.onetrust.com/blog/principles-of-privacy-by-design/", "https://docs.github.com/en/rest/commits/statuses", "https://blog.twitter.com/engineering/en_us/a/2015/diffy-testing-services-without-writing-tests.html", - "https://blog.github.com/2012-09-17-contributing-guidelines/" + "https://blog.github.com/2012-09-17-contributing-guidelines/", + "https://www.fast.design/docs/integrations/react" ], "only_errors": true, "cache_duration": "24h",