From a782e9c0568e74a512a8a15b00e90f39c022b30b Mon Sep 17 00:00:00 2001 From: SireeKoolenWijkstra Date: Mon, 14 Apr 2025 11:56:54 +0200 Subject: [PATCH 1/2] docs(docs/general): import docs from development-standards repo --- docs/frontend/accessibility.md | 22 ++++++++++++---------- docs/general/languages-and-frameworks.md | 4 ++-- docs/general/project-documentation.md | 2 +- docs/general/readme-default.md | 12 ++++++++---- docs/general/using-git.md | 2 +- 5 files changed, 24 insertions(+), 18 deletions(-) diff --git a/docs/frontend/accessibility.md b/docs/frontend/accessibility.md index 8ad0448..ad416be 100644 --- a/docs/frontend/accessibility.md +++ b/docs/frontend/accessibility.md @@ -1,10 +1,10 @@ # Accessibility -> This page was last reviewed 6th March 2024. It needs to be reviewed again on the 6th December 2024. +> This page was last reviewed on 6 February 2025. It needs to be reviewed again on 6 November 2025. ## What is the standard for accessibility? -In accordance with the Digital Government Act, the municipality of Amsterdam is required to build all its websites and applications in compliance with the Web Content Accessibility Guidelines (WCAG) at levels A and AA. +In accordance with the Digital Government Act, the municipality of Amsterdam is required to build all its websites and applications in compliance with the Web Content Accessibility Guidelines (WCAG) 2.1 at AA level. ## When and for whom is this standard applicable? @@ -20,14 +20,15 @@ The law is applicable to all government websites and applications, including int - [ ] zooming in at 200% - [ ] verify that all links feature descriptive link text - [ ] Evaluate the usability of your application by - - [ ] testing a workflow on your application without the use of a keyboard. Employ screen readers, such as [JAWS](https://accessibility.psu.edu/screenreaders/jawscommands/) or [VoiceOver](https://support.apple.com/guide/voiceover-guide/welcome/web). - - [ ] confirm the page's order is logical - - [ ] verify all content is accessible to the screen reader - - [ ] testing a workflow on your application without the use of a mouse Employ keyboard shortcuts - - [ ] check if the focus ring remains consistently visible -- [ ] Ensure all videos are captioned -- [ ] Ensure all audio is described as needed -- [ ] Ensure all audio-only files are transcribed + - [ ] testing a workflow on your application without the use of a keyboard or mouse. Employ screen readers, such as [JAWS](https://accessibility.psu.edu/screenreaders/jawscommands/) or [VoiceOver](https://support.apple.com/guide/voiceover-guide/welcome/web). + - [ ] ensure logical page order + - [ ] confirm screen reader compatibility + Employ keyboard shortcuts + - [ ] check focus ring visibility when navigating +- [ ] Ensure all multimedia has alternatives: + - [ ] videos must have captions + - [ ] audio must have descriptions + - [ ] audio-only content must be transcribed ### on a web application? @@ -94,6 +95,7 @@ Testing accessibility thoroughly can be challenging. Consider collaborating with - [Testing for Accessibility](https://accessibility.psu.edu/testing/protocol/) - [Praktische toegankelijkheidstips](https://www.digitoegankelijk.nl/aan-de-slag/tips) +- [WCAG rules and regulation](https://wcag.nl/kennis/wet-en-regelgeving/) ## Acknowledgments diff --git a/docs/general/languages-and-frameworks.md b/docs/general/languages-and-frameworks.md index 2748d8e..78765b0 100644 --- a/docs/general/languages-and-frameworks.md +++ b/docs/general/languages-and-frameworks.md @@ -1,6 +1,6 @@ # Languages & Frameworks for Software Development -> This page was last reviewed October 10th 2024. It needs to be reviewed again on April the 10th 2025. +> This page was last reviewed on 10th April. It needs to be reviewed again on 10th January 2026. ## What is the standard? @@ -19,7 +19,7 @@ New frontend applications are developed using **[TypeScript](https://www.typescr - UI logic is implemented with **[React](https://react.dev/)** in combination with the **[Amsterdam Design System](https://designsystem.amsterdam/)**. - CSS is implemented using **[CSS modules](https://github.com/css-modules/css-modules)**. -- Full application development is implemented with **[Next.js](https://nextjs.org/)** or **[Remix](https://remix.run/)**. +- Full application development is implemented with **[Next.js](https://nextjs.org/)** or **[React Router (Framework)](https://reactrouter.com/)**. ### Mobile Applications diff --git a/docs/general/project-documentation.md b/docs/general/project-documentation.md index 396cdf4..a652479 100644 --- a/docs/general/project-documentation.md +++ b/docs/general/project-documentation.md @@ -1,5 +1,5 @@ # Documentation -> This page was last reviewed 6th March 2024. It needs to be reviewed again on the 6th December 2024. +> This page was last reviewed 13 February 2025. It needs to be reviewed again on 13 November 2025. ## What is the standard for documentation? Include documentation in your project that facilitates understanding, usage, and maintenance of your code. The documentation should promote usability and longevity of your project, and effective collaboration among your stakeholders. diff --git a/docs/general/readme-default.md b/docs/general/readme-default.md index fee4c90..194cf50 100644 --- a/docs/general/readme-default.md +++ b/docs/general/readme-default.md @@ -1,10 +1,10 @@ # Readme files -> This page was last reviewed on April 23rd, 2024. It needs to be reviewed again on January 23rd, 2025. +> This page was last reviewed on February 3rd, 2025. It needs to be reviewed again on November 3rd, 2025. ## What is the standard for a README for the city of Amsterdam? -There must be a README.md file for every Github repository of the city of Amsterdam. A README.md file should be an overview and list of instructions to help someone get started with your project. +There must be a README.md file for every Github repository of the city of Amsterdam. A README.md should briefly describe the project, its purpose, and provide clear instructions to help developers, contributors, and stakeholders navigate and use the repository effectively. ## When and for whom is this standard? @@ -15,10 +15,14 @@ This standard must be applied to all new repositories of the city of Amsterdam ( A README must include the following: -- [ ] Name of the project and a short introduction. Give the objectives and motivation behind the project and, if applicable, give the URL of the web application. +- [ ] Name of the project and a short introduction. This should include: + - [ ] A brief overview of the project’s purpose. + - [ ] The main objectives and motivation behind it. + - [ ] (If applicable) A link to the deployed web application and relevant documentation. - [ ] Name of the team responsible for maintaining the project and how to contact them. - [ ] An installation guide which contains information about software dependencies. -- [ ] A how-to build and test the application +- [ ] A how-to build and test the application. +- [ ] Guidelines on where to report bugs or request features (e.g., GitHub Issues, Jira). ## What pitfalls to avoid? diff --git a/docs/general/using-git.md b/docs/general/using-git.md index 9eaccfa..e7aa640 100644 --- a/docs/general/using-git.md +++ b/docs/general/using-git.md @@ -1,5 +1,5 @@ # Using Git -> This page was last reviewed May 14th, 2024. It needs to be reviewed again on February 14th, 2025. +> This page was last reviewed 13 February 2025. It needs to be reviewed again on 13 November 2025. ## What is the standard for using Git? The city of Amsterdam uses Git to push its code to GitHub. From 9144f40432889f1e7908dc5e4b400d6785fa4420 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 14 Apr 2025 09:58:09 +0000 Subject: [PATCH 2/2] Release v0.5.1 --- CHANGELOG.md | 7 +++++++ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4f8ef28..98b158a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ +## [0.5.1](https://github.com/Amsterdam/ee-docs/compare/v0.5.0...v0.5.1) (2025-04-14) + + +### Bug Fixes + +* **searchpage:** update swizzled search template to resolve build errors ([#126](https://github.com/Amsterdam/ee-docs/issues/126)) ([c504890](https://github.com/Amsterdam/ee-docs/commit/c504890f74e65cc176ccceedf449c05dba8d4d39)) + ## [0.5.0](https://github.com/Amsterdam/ee-docs/compare/v0.4.0...v0.5.0) (2025-02-06) diff --git a/package-lock.json b/package-lock.json index e57870e..4ed5ce9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "docusaurus", - "version": "0.5.0", + "version": "0.5.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "docusaurus", - "version": "0.5.0", + "version": "0.5.1", "dependencies": { "@amsterdam/design-system-assets": "^0.2.2", "@amsterdam/design-system-css": "^0.13.1", diff --git a/package.json b/package.json index 0f67410..c10b2db 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus", - "version": "0.5.0", + "version": "0.5.1", "private": true, "scripts": { "docusaurus": "docusaurus",