Orange-OpenSource / ods-ios

A SwiftUI components library with code examples for Orange Design System
https://orange-opensource.github.io/ods-ios/
MIT License
25 stars 6 forks source link

Add accessiiblity statement in documentation, and open it through the app menu #786

Closed pylapp closed 4 months ago

pylapp commented 4 months ago

Description

In the online documentation (available at github.io), add the last accessibility statement somewhere (e.g. here). No need to version this statement and keep several versions: one audit matches one version of the app but it is possible to have some versions of the app which were not audited. No interests in keeping several versions of the statement in the filetree : Git as a VCS will be enough.

Tasks

pylapp commented 4 months ago

Items to use attached a11y-orange-design-system.zip

Linked to https://github.com/Orange-OpenSource/ods-ios/issues/764

pylapp commented 4 months ago

@pya35 I uploaded the resources you sent me in the documention folder. I changed also the URL to open in the app side. However I still don't know how to test it ; I did not configure the Netlify process and I fear the online documentation will be updated only when releases are done.

@julien-deramond Do you have some ideas? Everyhing seems to be ok for me, but actually the URL in use (https://orange-opensource.github.io/ods-ios/accessibilityStatement/orange-design-system.html) points to the 404 page. How to update the web documentation without making releases (if it is possible)?

julien-deramond commented 4 months ago

Locally, in your qualif branch it works well:

cd docs
bundle install
bundle exec jekyll serve -H 0.0.0.0 --trace --watch --force_polling --livereload --livereload-port 4002
# Then going to http://localhost:4000/ods-ios/accessibilityStatement/orange-design-system.html shows the page

When it's been merged, nothing was triggered to update the public documentation: Screenshot 2024-03-08 at 06 26 28

IMO this is kinda normal since you'd want your documentation to be public only either when you release, or each time you push to your main branch (IDK your current approach).

With your release commit the other day on the main branch, the update of the documentation happened:

Screenshot 2024-03-08 at 06 29 42

IDK exactly how it's configured the project, but some commits on the main branch launch the update of the documentation and others don't. We'd need to check that together. But the idea here would be for you to get this documentation modification (the corresponding commit of this issue) into your main branch and retrigger if possible the process that updates the doc without releasing a new version of the lib.

pylapp commented 4 months ago

Thank you for all these details! Documentation has been merged, and the evolution is available since the new release v1.1.0. More details in the dedicated announcement #790 :)

pya35 commented 4 months ago

Thank you for the good job @pylapp