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

Change path of example URIs so examples are in subdirectory of their respective pattern #80

Closed
mcking65 opened this issue May 11, 2022 · 3 comments

Comments

@mcking65
Copy link
Contributor

mcking65 commented May 11, 2022

Change the URI path of examples so an example implementation of a pattern is in a subdirectory of the pattern.

For instance, for combobox examples, instead of the examples being in /index/ like this:

/examples-index/combobox/combobox-autocomplete-both.html
/examples-index/combobox/combobox-autocomplete-list.html
/examples-index/combobox/combobox-autocomplete-none.html

Make the URI path to be /patterns/PATTERN_DIR/examples, like this:

/patterns/combobox/examples/combobox/combobox-autocomplete-both.html
/patterns/combobox/examples/combobox/combobox-autocomplete-list.html
/patterns/combobox/examples/combobox/combobox-autocomplete-none.html

This will re-enforce the relationship between a pattern and its examples.

It would be good to do this as soon as possible to avoid bookmark churn for users.

Originally posted by @mcking65 in #76 (comment)

@alflennik
Copy link
Contributor

We discussed this and I want to just share my understanding about the best way to tackle this. If it doesn't jive with your expectation @mcking65 let me know.

  1. We update the APG repo to organize the files in the way Matt described above, in a branch. This may necessitate a temporary content freeze, or at least any fixes would need to be applied in both main and the updated branch.
  2. Once the content is organized, we can then update the wai-aria-practices repo to support the new content organization, resulting in new URLs like the ones described above.

Let me know if anything is missing here. For example I understand we want to set up redirects from the existing URL structure to the new URL structure.

@mcking65
Copy link
Contributor Author

@alflennik this is correct at a high level. The huge piece of work is the reorganization of content. I have mapped that out in w3c/aria-practices#2418 and begun work in w3c/aria-practices#2417. I'd like to discuss that work during the APG meeting this week if possible.

@mcking65
Copy link
Contributor Author

mcking65 commented Feb 1, 2023

work done by w3c/aria-practices#2417 is now complete and published; closing.

@mcking65 mcking65 closed this as completed Feb 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants