Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
3 tasks done
pylapp opened this issue Mar 7, 2024 · 5 comments · Fixed by #787
Closed
3 tasks done

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

pylapp opened this issue Mar 7, 2024 · 5 comments · Fixed by #787
Assignees
Labels
👂 acessibility 📖 documentation Improvements or additions to documentation

Comments

@pylapp
Copy link
Member

pylapp commented Mar 7, 2024

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

  • Add in the documentation a new "accessiiblity-statement" folder
  • Place inside the elements
  • Update the app code to point to the HTML page
@pylapp pylapp added 📖 documentation Improvements or additions to documentation 👂 acessibility labels Mar 7, 2024
@pylapp pylapp self-assigned this Mar 7, 2024
@pylapp
Copy link
Member Author

pylapp commented Mar 7, 2024

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

Linked to #764

pylapp added a commit that referenced this issue Mar 7, 2024
Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>
pylapp added a commit that referenced this issue Mar 7, 2024
…ine doc

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>
pylapp added a commit that referenced this issue Mar 7, 2024
…ntation (#787)

* chore(#786): add ressources

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>

* doc: update version to use of package in doc

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>

* chore(#786): point to accessibility statement HTML page stored in online doc

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>

---------

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>
@pylapp pylapp reopened this Mar 7, 2024
@pylapp
Copy link
Member Author

pylapp commented Mar 7, 2024

@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
Copy link
Member

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
Copy link
Member Author

pylapp commented Mar 8, 2024

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 :)

@pylapp pylapp closed this as completed Mar 8, 2024
@pya35
Copy link
Member

pya35 commented Mar 8, 2024

Thank you for the good job @pylapp

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👂 acessibility 📖 documentation Improvements or additions to documentation
Projects
None yet
3 participants