Hosting location for the Onion Services Ecosystem Documentation
Motivation
As mentioned in the previous issue about getting domains for some Onion Services projects, we're looking for
- Shorter URLs for some Onion Services related projects, pointing to their GitLab Pages.
- Aggregate Onion Services documentation in a single, searchable place.
That made us create the Onion Services Ecosystem Documentation, but it still has a not very friendly URL.
Tasks
-
Organization: -
Ping some people to get feedback (ahf, gaba, micah?). -
Determine a better canonical URL location for the Onion Services Ecosystem Documentation: -
Project/repository name: tpo/onion-services/ecosystem
. -
Canonical URL: https://onionservices.torproject.org
(previously:https://community.torproject.org/onion-services/ecosystem
).
-
-
Rename the project from portal
toecosystem
.
-
-
Implementation: -
Proceed with the CI/deployment changes to make the Onion Services Ecosystem Documentation accessible through the new URL: -
Update CI config to use the static shim deploying to the static component. No need, since we'll use the existing deployment fromtpo/web/community
. -
Update CI config to use a setup similiar to the Community Policies (!6 (merged)). -
Update web/community CI config to include the Ecosystem Docs (tpo/web/community!349 (merged)).
-
-
Ask TPA to help with setting up this deployment. There was no need initially, since we used the existing deployment from tpo/web/community
. But then we decided to go with a separate site, whose setup is tracked at tpo/tpa/team#41687 (closed). -
Update references in Onion Services projects, pointing to the new official/canonical documentation location (like on README.md
files etc). -
Create .htaccess
-like redirects from the old location to the new location (if applicable). -
Once the portal is deployed, update the "Onionize any website" link in the Community Portal, pointing to the official Onionspray documentation URL within the Onion Services Ecosystem Portal (tpo/web/community#337 (closed)). Moved to #11. -
Link the Onion Services Ecosystem Documentation in the Onion Services section of the Community Portal. Moved to #11. -
Add banner in the community portal, at the Onion Services page. Moved to #11. -
Figure out an update workflow. This was sorted out once we decided to go with a separate domain.
-
-
Bonus:-
Consider to release the portal as part of the Onion Services 20th Years Anniversary (2024 edition). Moved to #11. -
Onion Services endpoint and Onion-Location set (if not already available). Moved to #11.
-
-
Advertise:
Time estimation
- Complexity: small (1 day)
- Uncertainty: low (x1.1)
- Reference (adapted)
/cc @gus
Edited by Silvio Rhatto