Developer's documentation at readthedocs.io

[woju]

• add QubesOS/qubes-core-admin as subproject (https://qubes-os.readthedocs.io/projects/core-admin/en/latest/)
• merge QubesOS/qubes-doc#430
• switch repo at readthedocs.org's admin panel
• check hook at github
• add CNAME or proxy at cloudflare
• link at qubes-os.org/doc/
• fix link to qubes-os.org/doc/ from readthedocs

---

• write table of contents
• adjust theme

[woju]

Cc: @andrewdavidwong @marmarek

[woju]

Cc: @andrewdavidwong @marmarek

[marmarek]

@woju please add CNAME to dev.qubes-os.org in readthedocs.org admin panel (DNS already done)

[marmarek]

@woju please add CNAME to dev.qubes-os.org in readthedocs.org admin panel (DNS already done)

[woju]

done

[woju]

done

[andrewdavidwong]

Regarding the item "link at qubes-os.org/doc/," I think we decided (in the email thread about this) to link from the main doc index (qubes-os.org/doc/) to each component (dev.qubes-os.org/some-component/), but not to link from the doc index to the subdomain landing page (dev.qubes-os.org). Since we don't have any component pages yet, there's nothing to link to yet.

[andrewdavidwong]

Regarding the item "link at qubes-os.org/doc/," I think we decided (in the email thread about this) to link from the main doc index (qubes-os.org/doc/) to each component (dev.qubes-os.org/some-component/), but not to link from the doc index to the subdomain landing page (dev.qubes-os.org). Since we don't have any component pages yet, there's nothing to link to yet.

[marmarek]

https://dev.qubes-os.org/projects/core-admin/en/latest/

[marmarek]

https://dev.qubes-os.org/projects/core-admin/en/latest/

[marmarek]

@woju please add also core-admin-client sub-project

[marmarek]

@woju please add also core-admin-client sub-project

[andrewdavidwong]

Added link from qubes-os.org/doc/ to core-admin documentation.

[andrewdavidwong]

Added link from qubes-os.org/doc/ to core-admin documentation.

[woju]

@woju please add also core-admin-client sub-project

Added: https://dev.qubes-os.org/projects/core-admin-client/ https://qubes-core-admin-client.readthedocs.io/

@andrewdavidwong Could you link it from https://qubes-os.org/doc/?

@marmarek: you'll get notifications about failed builds (I'll too).
@andrewdavidwong: Would you like to get e-mail notifications about failed builds of dev.qubes-os.org and/or some of the subrepos from RTD?
And question to you both: do we need single email alias for that? Assuming we'd get more of the repositories linked there, managing those notifications will get trickier.

[woju]

@woju please add also core-admin-client sub-project

Added: https://dev.qubes-os.org/projects/core-admin-client/ https://qubes-core-admin-client.readthedocs.io/

@andrewdavidwong Could you link it from https://qubes-os.org/doc/?

@marmarek: you'll get notifications about failed builds (I'll too).
@andrewdavidwong: Would you like to get e-mail notifications about failed builds of dev.qubes-os.org and/or some of the subrepos from RTD?
And question to you both: do we need single email alias for that? Assuming we'd get more of the repositories linked there, managing those notifications will get trickier.

[marmarek]

And question to you both: do we need single email alias for that? Assuming we'd get more of the repositories linked there, managing those notifications will get trickier.

I'd say: send them to qubes-devel, but 1) I'm not sure if this is a good idea in the first place, 2) may need some tricky subscription setup (qubes-devel is moderated for non-members).
But what I want to say - we may need something like ML - publicly available - for notifications from such automatic services. This will also include mails with automatic tests results etc.

[marmarek]

And question to you both: do we need single email alias for that? Assuming we'd get more of the repositories linked there, managing those notifications will get trickier.

I'd say: send them to qubes-devel, but 1) I'm not sure if this is a good idea in the first place, 2) may need some tricky subscription setup (qubes-devel is moderated for non-members).
But what I want to say - we may need something like ML - publicly available - for notifications from such automatic services. This will also include mails with automatic tests results etc.

[andrewdavidwong]

@woju:

@andrewdavidwong Could you link it from https://qubes-os.org/doc/?

Done: QubesOS/qubes-doc@066bd62

@andrewdavidwong: Would you like to get e-mail notifications about failed builds of dev.qubes-os.org and/or some of the subrepos from RTD?

If it's not actionable information for me, then no, but thank you for asking. 🙂

And question to you both: do we need single email alias for that? Assuming we'd get more of the repositories linked there, managing those notifications will get trickier.

I think I agree with Marek on this. Something like https://github.com/QubesOS/updates-status/issues for mails?

[andrewdavidwong]

@woju:

@andrewdavidwong Could you link it from https://qubes-os.org/doc/?

Done: QubesOS/qubes-doc@066bd62

@andrewdavidwong: Would you like to get e-mail notifications about failed builds of dev.qubes-os.org and/or some of the subrepos from RTD?

If it's not actionable information for me, then no, but thank you for asking. 🙂

And question to you both: do we need single email alias for that? Assuming we'd get more of the repositories linked there, managing those notifications will get trickier.

I think I agree with Marek on this. Something like https://github.com/QubesOS/updates-status/issues for mails?

[woju]

The notifications would be sent from readthedocs@readthedocs.org (with a Return-Path of <bounce\+[0-9a-f.]*-qubes-devel=googlegroups.com@readthedocs\.org>). Could you whitelist that address? If you'd need a message actually sent from this address, I can provoke one. :)

[woju]

The notifications would be sent from readthedocs@readthedocs.org (with a Return-Path of <bounce\+[0-9a-f.]*-qubes-devel=googlegroups.com@readthedocs\.org>). Could you whitelist that address? If you'd need a message actually sent from this address, I can provoke one. :)

[marmarek]

I think I agree with Marek on this. Something like https://github.com/QubesOS/updates-status/issues for mails?

Yes, something like this. I think this is generic question: do we want automated notifications on qubes-devel, or somewhere else?

[marmarek]

I think I agree with Marek on this. Something like https://github.com/QubesOS/updates-status/issues for mails?

Yes, something like this. I think this is generic question: do we want automated notifications on qubes-devel, or somewhere else?

[andrewdavidwong]

Yes, something like this. I think this is generic question: do we want automated notifications on qubes-devel, or somewhere else?

Probably better to have it on a separate list so that it's opt-in for people who already subscribe to qubes-devel.

[andrewdavidwong]

Yes, something like this. I think this is generic question: do we want automated notifications on qubes-devel, or somewhere else?

Probably better to have it on a separate list so that it's opt-in for people who already subscribe to qubes-devel.

[andrewdavidwong]

@woju:

If someone goes to https://dev.qubes-os.org/, there's no useful content. There are three links listed on that page, but they're all either empty or 404. People who go to that page should at least be able to see a list of all the meaningful pages, which I guess are:

• https://dev.qubes-os.org/projects/core-admin/en/latest/
• https://dev.qubes-os.org/projects/core-admin-client/en/latest/

[andrewdavidwong]

@woju:

If someone goes to https://dev.qubes-os.org/, there's no useful content. There are three links listed on that page, but they're all either empty or 404. People who go to that page should at least be able to see a list of all the meaningful pages, which I guess are:

• https://dev.qubes-os.org/projects/core-admin/en/latest/
• https://dev.qubes-os.org/projects/core-admin-client/en/latest/

[woju]

@andrewdavidwong Some time ago I put links there, now I put link back to q-o.org/doc/, and the theme is consistent with all other docs. Should we close?

[woju]

@andrewdavidwong Some time ago I put links there, now I put link back to q-o.org/doc/, and the theme is consistent with all other docs. Should we close?

[andrewdavidwong]

👍

[andrewdavidwong]

👍