Suggestion: Inform users about documentation changes

23 views
Skip to first unread message

grzegorz....@gmail.com

unread,
Jul 13, 2016, 9:56:59 AM7/13/16
to qubes-users
It would be a nice feature if entries in the Qubes Docs showed the date of the last update or a tag (preferably bright and colorful) showing which of the docs were updated within the last 3 days, a week, a month etc. This will prevent users from missing out on useful information because it was added to an entry that has already been read by users.

Alex

unread,
Jul 13, 2016, 10:22:53 AM7/13/16
to qubes...@googlegroups.com
+1!

--
Alex

signature.asc

Andrew David Wong

unread,
Jul 13, 2016, 11:18:21 AM7/13/16
to grzegorz....@gmail.com, qubes-users
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
You can already view this easily by clicking the "View Page Source" link on
any documentation page. That will show you the last commit (near the top of
the page), and you can see the rest of the available commit history by
clicking the "History" button.

- --
Andrew David Wong (Axon)
Community Manager, Qubes OS
https://www.qubes-os.org
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJXhluxAAoJENtN07w5UDAwsPMP/0TUugQPR3sXu9TXtpxUeSZv
vj64NMdbLkcgX/6YQxOOpLiinhYBrHFVjPBPeifTZiUGbPmE3kRx7+c1N3UHDZd+
E2RM5ZTZxvz9nF8I3IVMnVK+T5Pul5iBWbFgZTcvRhVY6loULv2rlYISu9hWkkYX
+D5uByaW+aEoBULYQgvjB/6LInC0VYPpJE5oUS2jeQ4Do4ChDH9tiaLujz8u9Fab
uuNvaj3ZHHAuGVVg3ygD5+USwlw9BP85DNzC6mEV8MHc0khPzw3pwx0krQ59L4OU
DM6Zd7gHdSQ4SwrkCkpk9OHsFKcqro2v/mFtBsTNTlwCM5JWiosBnsPBl4U+JYL7
2yRPHye4tj+BeLeX9bXgOWdCGLbndQ4IxAUaWF+QWanJpiTeCPWHXRBIkXno2CId
j3csGcA2nxak713jtyNAcHAVicXlnARU8LxGaq8UbiNmoQ3YJtN28kS6XRRFiPIM
2noXY02mRa/JqtQ1b3cYfvLGJd3NkuDX+MPEJoHfXwJyukROiEjCv02N7TFIb2jX
OIyl2Bgtd2syOT7EJAu1fvK7CEkuWzc3ZE8u8A9gDrP0fZAKyTEZ7oQkU8ZCqHdh
nZTjvP4cUrC9QOHUQR1V7c1A3fNsxIp6qZPG9gnIPsOGH5vVSC+P6AYdqGOoLD3q
PtulOlZ9pZ36ss+pQne8
=2LNw
-----END PGP SIGNATURE-----

Andrew David Wong

unread,
Jul 13, 2016, 11:25:56 AM7/13/16
to grzegorz....@gmail.com, qubes-users
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

On 2016-07-13 08:18, Andrew David Wong wrote:
> On 2016-07-13 06:56, grzegorz....@gmail.com wrote:
>> It would be a nice feature if entries in the Qubes Docs showed the date
>> of the last update or a tag (preferably bright and colorful) showing
>> which of the docs were updated within the last 3 days, a week, a month
>> etc. This will prevent users from missing out on useful information
>> because it was added to an entry that has already been read by users.
>
>
> You can already view this easily by clicking the "View Page Source" link
> on any documentation page. That will show you the last commit (near the top
> of the page), and you can see the rest of the available commit history by
> clicking the "History" button.
>

You can also view all the changes to the qubes-doc repo by looking at the
commit log:

https://github.com/QubesOS/qubes-doc/commits/master

- --
Andrew David Wong (Axon)
Community Manager, Qubes OS
https://www.qubes-os.org
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJXhl18AAoJENtN07w5UDAwhjMP/jyTcku1hZE9WbK9CB3wRpi6
rLEF911DWpCjt3Gv4N4wWgNf1VEOrqJBiXWLxgsy4cNAcYyEt8soR3gG7CPn9jzO
Mm/8ogqQYoSiurPvJ84N34VJTxcuJaaVmtmJEooNY6S5fqERI0FFSnPxyN9MQnC6
n4ltDDPzhjq+kU1mX11K5+cFbhgDrZ45D0vtStopHboKr7Hi+fq5cV8nVywKdh99
0moo9XP2LT4MLyNqllAmVQFWPab752nffRgn0B1DjPKUe4vDl5N/Y/Iq2QxlNn8l
b/KqXlnPA45KMvhhykJC6ipghAHoEAwKGsT3uhdHhRChGVaacfhTtuEoFPH7qx8h
Dod7hB24Qyzzfle3OakM8Nk4vcCHIRIhirfNP+WKW4SjDismdBOTx2qkna97LvaZ
3dvTJTL/RLnL/IksdCosC7by4KoH8hZrAJQxlp/ggqwjTlTaz5ft9v3J6gbDF9Hj
M3dAcyL16DGbXP2RUBrmYLV6nWKRJVceUFa1pA28hbjkEDMLV2qLDy9xb47qU3EU
EVKKOBYKtL/C8GipAMy+gNCp06tAthMLqhWlOR6DcRzUAK6e7Dc4uOSAB7MRnDX9
RbliL01Y8ExnYuaCZpPgy9vxD4KCJm6vDAe/+/AaCo7eezMxUiAtYlsxSw6LVl6U
suoBvi9Xy2W+BIFF3dd+
=AQUu
-----END PGP SIGNATURE-----

grzegorz....@gmail.com

unread,
Jul 13, 2016, 1:32:21 PM7/13/16
to qubes-users, grzegorz....@gmail.com
That requires opening a specific doc entry page instead of the general Docs page, and

> You can also view all the changes to the qubes-doc repo by looking at the
> commit log:
>
> https://github.com/QubesOS/qubes-doc/commits/master

This solution is a little more convenient but still requires the user to leave the doc page.

Andrew David Wong

unread,
Jul 13, 2016, 2:32:19 PM7/13/16
to grzegorz....@gmail.com, qubes-users
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

On 2016-07-13 10:32, grzegorz....@gmail.com wrote:
> W dniu środa, 13 lipca 2016 17:25:56 UTC+2 użytkownik Andrew David Wong
> napisał: On 2016-07-13 08:18, Andrew David Wong wrote:
>>>> On 2016-07-13 06:56, grzegorz....@gmail.com wrote:
>>>>> It would be a nice feature if entries in the Qubes Docs showed the
>>>>> date of the last update or a tag (preferably bright and colorful)
>>>>> showing which of the docs were updated within the last 3 days, a
>>>>> week, a month etc. This will prevent users from missing out on
>>>>> useful information because it was added to an entry that has
>>>>> already been read by users.
>>>>
>>>>
>>>> You can already view this easily by clicking the "View Page Source"
>>>> link on any documentation page. That will show you the last commit
>>>> (near the top of the page), and you can see the rest of the available
>>>> commit history by clicking the "History" button.
>>>>
>
> You can also view all the changes to the qubes-doc repo by looking at the
> commit log:
>
> https://github.com/QubesOS/qubes-doc/commits/master
>
>
>
>>> You can already view this easily by clicking the "View Page Source"
>>> link on any documentation page. That will show you the last commit
>>> (near the top of the page), and you can see the rest of the available
>>> commit history by clicking the "History" button.
>
> That requires opening a specific doc entry page instead of the general Docs
> page, and
>
>> You can also view all the changes to the qubes-doc repo by looking at
>> the commit log:
>>
>> https://github.com/QubesOS/qubes-doc/commits/master
>
> This solution is a little more convenient but still requires the user to
> leave the doc page.
>

You should understand that the website is just one of many possible frontends
for accessing the documentation. The qubes-doc git repo is the documentation
"in itself." It can be accessed through qubes-os.org, github.com, and (soon),
offline within Qubes OS, but it is independent of all of those. As a git repo,
the ability to track and view changes is an inherent feature of the
documentation that already necessarily exists.

Nonetheless, I'm opening an issue for your suggestion as a website enhancement:

https://github.com/QubesOS/qubes-issues/issues/2169

(You actually made two separate suggestions in your OP, so I'm choosing the
title based on the first one. Also, your subject line is actually conveying a
different idea than the two suggestions you make. If you simply want to be
informed about documentation changes, you can also subscribe to an RSS feed of
the git log via GitHub.)

- --
Andrew David Wong (Axon)
Community Manager, Qubes OS
https://www.qubes-os.org
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJXhokqAAoJENtN07w5UDAw4TkP/1naTMFiKUADQLjvtJ2M+0Ie
h7akO2HaCN3t5YM+p+Y2Ed7Cbd8b8WqsI3XXNkSAnN8Wo7urQI7qFJeONCxS9I72
Aqwoe+His33uUTF0fuWWpL/cZBveUmLZTUNNZhYddWO5SE9C2AUVQO90sPK7FnZv
JjvfdRcbWQnt3Gh8HD3hsoC9xE7QNDDtgo8qf7lSGXFXus2gsFIfhwYkrwmXYZ1R
oAq3WuhUDircSSwl32IA8NUXyTFhJFWEvfD7nkYK9oxr5z7tB6pv4JNhkykV5WsT
nJKVZyUpWw8+sJu66OMiyk2LpoMf4CjpRUaewq7cH9y9tId8TNn/ejbgL61PPysh
KUD+v9HPiA0qm0IOml03XMOivNo1dtiaPU7E/MNMuaZjOe4Y2MMv+HtdOY4LE9Qi
TSyq0EEPK4I+FQbwEdlS2j7/z0X+g2oVZYzS5BuGHd0RqhdpuDxWC5DItmbMNzUm
wjzvA8sTyQY2V6tpT1DDTYyh+Jsk0jw8HkVqQBsgy6Vg/b7rf2+Li6KWx1PG5DGJ
NobSRShS0fuGW2oDatEM9iv/pXCBEaILIMjcxPyhcihnVrvFimJ6Y1Y7yc0soG7m
s2Ak3WzU1D/cYxUN3lxwFkvcOEm6+O0R5rFIT0pjmmAtwtr+1qlwZX2q7yk5qlgU
4K5Qu4AYGqDjyBkE886T
=vTIP
-----END PGP SIGNATURE-----

grzegorz....@gmail.com

unread,
Jul 13, 2016, 2:38:03 PM7/13/16
to qubes-users, grzegorz....@gmail.com
Sorry about the confusion. The subject line was meant to suggest a general idea while the post itself described the way such mechanism could possibly work based on my experiences with other docs/wikis etc. I feel that the current github title accurately reflects what I hope would be done.
Reply all
Reply to author
Forward
0 new messages