Onion documentation

General Discussion
1

You probably know that the Qubes website is available (mostly) as an
onion site, at http://qubesosfasa4zl44o4tws22di6kepyzfeqv3tg4e3ztknltfxqrymdad.onion/

Qubes documentation is also now available as an onion at http://doc.qubesosfasa4zl44o4tws22di6kepyzfeqv3tg4e3ztknltfxqrymdad.onion/
It’s a work in progress - there are links that take you outwith the Tor
network, but these are marked - generally it’s self contained.

The Documentation link on the onion site now takes you to the onion
doc site. Much better.

If you dont know what an onion site is, or why you might want to use
it, read this

The source for documentation is on GitHub. The onion site is mirrored
from source, and built with minor link rewritings.

The documentation is a community effort. Please help us improve it. This
is a good way to make a contribution to the project. Contributions are
always welcome - look at this page or on the onion

You can see the open issues re documentation on GitHub using the C:doc tag.
If you dont want to use GitHub, (and I completely understand that), you
can email or PM me with your contribution and I’ll merge it with credit
(if wanted).

13 Likes
2

I suggest we introduce the “.onion available” button (through html tag in the source code of the page) like it was done for the QubesOS main website:

image
image539×105 9.52 KB

This is the html tag to introduce in the source code:
<meta http-equiv="onion-location" content="http://doc.qubesosfasa4zl44o4tws22di6kepyzfeqv3tg4e3ztknltfxqrymdad.onion/">

@unman I’d do the pull request myself but I see qubesos/qubes-doc is only for the docs themselves and holds no source code at all. Should I create a request feature issue on QubesOS/qubes-issues ?

5 Likes
3

The qubes-doc repository is a complete Sphinx project.

To build it locally, see: How to edit the documentation — Qubes OS Documentation

You might be able to achieve that with the meta directive, used inside rst_prolog or rst_epilog in conf.py.

4

This involves quite more work than I thought, sadly.
Plus @unman cherrypicks which posts to reply and which not to according to his own convenience.
I think I’ll switch OS I dont like what I’ve been seeing for the last couple of years. I’ll stop sending my funding to them.

5

I do this, it’s not much work IMO

This clones the repository, then build the static website in /tmp/html_output

git clone https://github.com/QubesOS/qubes-doc.git
cd qubes-doc
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
sphinx-build . /tmp/html_output/
2 Likes
6

When you want to update

git pull -r
.venv/bin/sphinx-build . /tmp/html_output/
1 Like
7

I put the needs-doc tag on this topic, to remember to add the <meta> tag. That’s not my priority right now. Opening a feature request on Github about this is a good idea IMO.

I’m wondering if it is really that simple: adding a <meta> tag will fix the issue, nothing else?

8

Yes, it’s just a metadata telling there is an onion alternative, browsers with Tor supports can use this. There is a similar thing for I2P IIRC.

1 Like