Proposal to Clean up Repos to Avoid Wiki Rot
Closed this issue · 7 comments
On #180 there was a conversation about a repo naming system and on #172 there is a repository overview.
There are 117 repositories in github.com/solid and it is not easy for newcomers nor for people working on the repositories for some time to navigate between these repositories in a way that it is crystal clear what is the aim of each of the repositories.
The Process repository was started as an attempt to collectively agree on how to work on specific aims within github.com/solid including: administration of solid properties, standardisation work, and creating and maintaining the website solidproject.org. There are more activities going on in github.com/solid that the three just mentioned.
This is a proposal about how to gain clarity around the aims of the work happening in github.com/solid as well as clarity around who is responsible for what.
There are some repositories that used to fill the functions of the repositories already described here above but are no longer maintained by defined people. The key information needs to be combined with the repositories above and archived to avoid thinning of information and wiki rot.
| Repository | What needs to happen before archiving | Where this is now taking place instead |
|---|---|---|
| https://github.com/solid/Explaining-the-Vision-Panel | no action needed | Solidproject.org |
| https://github.com/solid/webid-oidc-spec | Move issues and pull requests to github.com/solid/specification | github.com/solid/specification |
| https://github.com/solid/solid-spec | Move issues and pull requests to github.com/solid/specification | github.com/solid/specification |
| https://github.com/solid/web-access-control-spec | Move issues and pull requests to github.com/solid/specification | github.com/solid/specification |
| https://github.com/solid/solid | Move issues and pull requests to github.com/solid/specification | github.com/solid/specification |
| https://github.com/solid/solid.mit.edu | no action | solid.mit.edu no longer attached to this repo |
| https://github.com/solid/websci-2019 | no action | solidproject.org/press |
| https://github.com/solid/Roadmap | no action | solidproject.org/roadmap (ticket to be created) |
| https://github.com/solid/solid-apps | no action | solidproject.org/use-solid |
| https://github.com/solid/pods | no action | solidproject.org/use-solid |
| https://github.com/solid/solid-idp-list | no action | solidproject.org/use-solid |
| https://github.com/solid/solid-idps | no action | solidproject.org/use-solid |
| https://github.com/solid/information | no action | solidproject.org |
| https://github.com/solid/context | no action | solidproject.org.for-developers |
| https://github.com/solid/vocab | no action | solidproject.org.for-developers |
| https://github.com/solid/solid-namespace | no action | solidproject.org.for-developers |
| https://github.com/solid/dweb-summit-2018 | no action | solidproject.org.for-developers |
| https://github.com/solid/talks | no action | solidproject.org.for-developers |
| https://github.com/solid/intro-to-solid-slides | no action | solidproject.org.for-developers |
| https://github.com/solid/profile-viewer-tutorial | no action | solidproject.org.for-developers |
| https://github.com/solid/solid-tutorial-angular | no action | solidproject.org.for-developers |
| https://github.com/solid/solid-tutorial-rdflib.js | no action | solidproject.org.for-developers |
| https://github.com/solid/understanding-linked-data | no action | solidproject.org.for-developers |
| https://github.com/solid/solid-tutorial-pastebin | no action | solidproject.org.for-developers |
| https://github.com/solid/solid-tutorial-intro | no action | solidproject.org.for-developers |
Solid Research
In the remaining ~50% of the repositories of github.com/solid there are a range of experiments and research on Solid. The aim of governance of the experimental research is not described in the process repository and largely started during the Solid MIT research project and has been picked up by the University of Ghent in more recent years.
Some of the research works on implementing the Solid standard to ensure the proposals are feasible. There is not a defined intention to provide this software as a service to end-users with a defined service provider, although some users do so organically. In particular node solid server is used by many developers as a reference Pod when building Solid applications.
Here are a list of repositories that could be tagged as 'research':
There are various implementations of the Solid specification.
| Implementation of Solid Specification | Associated Repositories |
|---|---|
| Implementation of Solid Server (Pod) | node-solid-server, node-solid-ws |
| Data Browser (app) | solid-ui, mashlib, solid-panes, Chat Pane, Solid Pane Source, Source Pane, Issue Pane, Contacts Pane, Folder Pane, Meeting Pane, Pane Registry, userguide |
| example applications | profile-viewer-react, solid-connections-ui, solid-profile-ui, solid-dashboard-ui, solid-signup-ui, solid-signin-ui, solid-sign-up, solid zagel |
| a way to take data from gitter chat and move it into Solid | gitter-solid |
There are various Solid-related libraries mostly being led by Ruben Verborgh.
| Description | Associated Repositories |
|---|---|
| An archive of built versions of various Solid-related libraries | releases |
| authentication tools | solid-auth-client, solid-auth-oidc, solid-auth-tls, oidc-auth-manager, solid-cli, solid-client, solid-multi-rp-client, oidc-web, oidc-op, oidc-rpoidc-rs, keychain, jose, wac-allow |
| authorisation tools | acl-check, solid-permissions |
| client-side libraries | react-components, form-playground |
| querying tools | query-ldflex, ldflex-playground, solid-tpf |
| a description of one way to implement the specification | solid-architecture |
Folllowing is a list of other Solid research:
aims within github.com/solid including: administration of solid properties, standardisation work, and creating and maintaining the website solidproject.org
I see github.com/solid as an open source project.
(ducks...)
Just had a chat with Mitzi, we agreed that the code repos can stay under github.com/solid, but we'll look for a way to clearly label a list of "code" repos that are still maintained, and we can clean up the ones that nobody is working on anymore.
Yes! We can just give every repo a 'solid' tag and then use an additional tag 'code' for the ones that contain code.
A few questions for you @Mitzi-Laszlo to make sure I'm understanding the proposal correctly:
- The first table seems to be a list of repositories that are proposed for archival, because of the "what needs to happen before archival" column heading. Is that accurate?
- Are the items in the "where this is now taking place" column where you are proposing any substantive materials be moved to? If so it should probably read something more along the lines of "should relocate to".
- Included in that list are active repositories like solid/vocab, solid/web-access-control-spec, solid/solid.mit.edu, solid/webid-oidc-spec. There are efforts underway to replace the specs with normative text and move them into the specification, but there is likely to need to be a bit more coordinated effort on those specifically beyond moving issues and pulls since better normative text doesn't exist yet somewhere else. solid.mit.edu website will probably need to remain until/unless there's a decision to retire that and redirect to solidproject.org.
- Are the items in the tables of the Solid Research section only being proposed to be tagged/categorized?
-
yes
-
yes
-
ok, let's add solid/vocab, solid/web-access-control-spec, solid/solid.mit.edu, solid/webid-oidc-spec to the research tag list.
-
yes
Following the implementation of the suggestions above here's an update of the repository overview of the Solid GitHub
Maybe wait to close issue until we have consensus and PR is merged?