qubes-issues icon indicating copy to clipboard operation
qubes-issues copied to clipboard

Published 20 hours ago • verified publisher icon QubesOS

RSS feed for documentation

Open emanruse opened this issue 1 year ago • 4 comments

The problem you're addressing (if any)

Currently, there is no convenient way for users to get notifications about new documentation articles or updates.

The solution you'd like

Provide an RSS feed(s) on the website, so users can subscribe selectively for:

  • newly published documentation articles
  • updates to existing articles

The value to a user, and who that user might be

Be informed about documentation updates.

emanruse avatar Feb 26 '24 09:02 emanruse

I think you can either:

  1. Use this: https://github.com/QubesOS/qubes-doc/commits/main.atom

or

  1. "Watch" https://github.com/QubesOS/qubes-doc, then get your own GitHub notifications as an RSS feed.

andrewdavidwong avatar Feb 26 '24 22:02 andrewdavidwong

Sure. But "watching" (in the GitHub sense) requires a GitHub registration which one may not [want to] have. So, the suggestion is more general.

emanruse avatar Feb 28 '24 08:02 emanruse

What about the first option? I think that works without any kind of registration.

andrewdavidwong avatar Feb 28 '24 19:02 andrewdavidwong

I didn't know you edited your reply (no email notifications about that).

To answer:

It still "ties" the user to GitHub, as the RSS does not contain the full text of the commits. But that is a small problem perhaps. The bigger one is - GitHub is censored in some countries, so some users may have a problem accessing it (and may not be experienced enough to follow development commits).

emanruse avatar Feb 28 '24 20:02 emanruse

On Wed, Feb 28, 2024 at 01:38:47PM -0800, andrewdavidwong wrote:

Assigned #8979 to @unman. I was afraid that was coming my way.

unman avatar Mar 02 '24 23:03 unman

On Wed, Feb 28, 2024 at 01:38:47PM -0800, andrewdavidwong wrote: Assigned #8979 to @unman. I was afraid that was coming my way.

No need to fear. This just means it's up to you, as the documentation and website maintainer, to decide how to triage the issue. If you don't believe any action should be taken, you are free to close the issue without taking any. If you believe it should be labeled "help wanted," you are free to unassign yourself.

My assigning it to you isn't a way of saying that you should do anything. Rather, it's a way of saying that you should decide what should be done.

andrewdavidwong avatar Mar 04 '24 03:03 andrewdavidwong