wiki cleanup - Githubissues

w3c / aria

Accessible Rich Internet Applications (WAI-ARIA)

https://w3c.github.io/aria/

Other

639 stars 123 forks source link

wiki cleanup #1882

Open pkra opened 1 year ago

pkra commented 1 year ago

As discussed at the editors meeting, the wiki is not in great shape. Most articles appear out of date. Very few have seen a significant update in the past year.

We should decide which pages we want to maintain and which alternative means we have to maintain them. We should also decide how to archive what we don't want to maintain.

pkra commented 1 year ago

Some examples

https://github.com/w3c/aria/pull/1872 adjusts the readme with links to 2 wiki pages. As they are directly related, they could be moved to the main repository, e.g., as MD files alongside the PR template or in a separate folder.
the onboarding page is the only other recently maintained page.
the spec for combobox has a note linking to a wiki page, https://github.com/w3c/aria/wiki/Resolving-ARIA-1.1-Combobox-Issues
some wiki pages were temporary pages that have since been integrated into the spec (e.g., annotations, braille props)
some old wiki pages are about very large ideas with unclear (to me) status, e.g., https://github.com/w3c/aria/wiki/CSS-AAM-Potential-Features

pkra commented 1 year ago

My impression is, the group has successfully used the wiki for temporary documents, i.e., drafts that led to spec changes.

If that's consensus, then perhaps the wiki should be focused on that, in which case the permanent content should move elsewhere (e.g., into the main repository) and old wiki pages can be deleted. In that case, we should check that the wiki works in terms of archival requirements; it's a git repository, so ideally nothing gets removed from the git history.

pkra commented 1 year ago

Accidental close - #1886 only partially resolves this.

pkra commented 1 year ago

In that case, we should check that the wiki works in terms of archival requirements; it's a git repository, so ideally nothing gets removed from the git history.

I just checked that the wiki works as you'd expect of any git repository -- deleted pages are just a regular commit (i.e. no purging) so they can be easily recovered if need be.

pkra commented 1 year ago

I've removed several pages that were obviously temporary or abandoned. I also updated the sidebar.

The next step would be to move notable pages into the repository's doc folder. I will start with just the final versions since we will still have the history in the wiki's git repository after removing the page if anyone needs it.