self-hosting a Sphinx documentation site

[Cory Francis Myers]

Hello, qubes-translation!

Thank you, m and Tobias, for your talk at the Qubes OS summit this past
weekend on your work on localizing Qubes's documentation. m, you and I
spoke afterwards about how the SecureDrop project recently moved our own
Sphinx documentation site from ReadTheDocs to self-hosting.
(Unfortunately, while the SecureDrop applications are localized, our
documentation is not.) You can find that work in the following pull
requests:

1. Sphinx generation
https://github.com/freedomofpress/securedrop-docs/pull/295

2. ReadTheDocs-style theme tweaks and "Edit on GitHub" links
https://github.com/freedomofpress/securedrop-docs/pull/301


I helped review this work but didn't implement any of it, but I can
confer internally if you have any questions.


--- cfm.


--
Cory Myers (he/him)
Senior Software Engineer, SecureDrop
Freedom of the Press Foundation

[Marek Marczykowski-Górecki]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On Thu, Sep 15, 2022 at 05:15:14PM -0700, 'Cory Francis Myers' via qubes-translation wrote:
> Hello, qubes-translation!
>
> Thank you, m and Tobias, for your talk at the Qubes OS summit this past
> weekend on your work on localizing Qubes's documentation. m, you and I
> spoke afterwards about how the SecureDrop project recently moved our own
> Sphinx documentation site from ReadTheDocs to self-hosting.
> (Unfortunately, while the SecureDrop applications are localized, our
> documentation is not.) You can find that work in the following pull
> requests:
>
> 1. Sphinx generation
> https://github.com/freedomofpress/securedrop-docs/pull/295
>
> 2. ReadTheDocs-style theme tweaks and "Edit on GitHub" links
> https://github.com/freedomofpress/securedrop-docs/pull/301
>
>
> I helped review this work but didn't implement any of it, but I can
> confer internally if you have any questions.

Thanks for the links!

Can you give some insight about reasoning for the migration? Related
issues point at a private repo...

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEEhrpukzGPukRmQqkK24/THMrX1ywFAmMjyXYACgkQ24/THMrX
1yyjnwgAhivQUp0zpZikri4y6xD5EL7ORSMkE0n91hK2Q+xjZ3aNdFQJDH2+MBjY
kR52Ogt+MIN4FA75k9JJPR2WU9Lo5D/pV0AYf1QcixORnL2T/XQHtYEVqdBpYnNs
4h5NC1yKtRuL7k4fMh9+X/qTtuRPmAaFcqiXWkWNN8YzMkfVJ7GMXmEzpKK2w2d0
iljJOwAwAPJ9s/+rClapt5WqGEyp+j5lZmzC6BFRcnLvHlxSzogsXHjNRlsssE87
p1Poowc92A3aCFrPxzbl+VOtu2rfrVWg+j/TK6c7hmPWpGCNVyMy21JUbFCQr83E
2KTV4/g6vwBIgX2AmbAUw0leiVpgPw==
=gGJ3
-----END PGP SIGNATURE-----

[Cory Francis Myers]

On Fri, Sep 16, 2022 at 02:55:18AM +0200, Marek Marczykowski-Górecki wrote:
> Can you give some insight about reasoning for the migration? Related
> issues point at a private repo...

The main motivation is to host our guide for submitting sources[1] as
much ourselves as possible, in order to limit the number of third-party
services (and trackers) they have to touch.

Towards that end, we also serve our self-hosted docs.securedrop.org with
an "onion-location" header. When we last tried that with ReadTheDocs,
via a reverse proxy, ReadTheDocs redirected back to the clearnet
address. (That was in 2018 and may have changed since then.)


--- cfm.


[1]: https://docs.securedrop.org/en/stable/source.html

[mm]

Hello!

Please excuse the belated reply from my side and the belated thank you
for the infos! :)

All the best,

m