[GSoD] Progress and next steps

31 views
Skip to first unread message

c1e0

unread,
Oct 10, 2020, 7:49:25 AM10/10/20
to qubes-devel
Hi everyone :)

Another week, another update :D

I have exhausted one month of the documentation development already. The next two months will be hectic, I bet. I'm trying to keep up with the revised timeline I shared in my last update.

Work done this week:
Plans for next week:
  • Editing Suspend/resume, VM, and HVM Troubleshooting based on PRs reviews.
  • Disk troubleshooting
  • PCI troubleshooting
  • USB troubleshooting

Marek Marczykowski-Górecki

unread,
Oct 10, 2020, 9:25:57 AM10/10/20
to c1e0, qubes-devel
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On Sat, Oct 10, 2020 at 04:49:25AM -0700, c1e0 wrote:
> Hi everyone :)
>
> Another week, another update :D
>
> I have exhausted one month of the documentation development already. The
> next two months will be hectic, I bet. I'm trying to keep up with the
> revised timeline I shared in my last update.
>
> *Work done this week:*
>
> - Addressed Travis CI build fails for Installation Troubleshooting:
> https://github.com/QubesOS/qubes-doc/pull/1047
> - Addressed Travis CI build fails for UEFI Troubleshooting:
> https://github.com/QubesOS/qubes-doc/pull/1048
> - Added new commits to UEFI Troubleshooting
> <https://github.com/QubesOS/qubes-doc/pull/1048> to address a new issue
> <https://github.com/QubesOS/qubes-issues/issues/6104>.
> - Suspend/resume Troubleshooting:
> https://github.com/QubesOS/qubes-doc/pull/1053
> - VM Troubleshooting: https://github.com/QubesOS/qubes-doc/pull/1055
> - HVM Troubleshooting: https://github.com/QubesOS/qubes-doc/pull/1056

I posted some review comments there.
As noted there, changes in the doc index like done now will conflict
between those PRs. I don't know clean _and effective_ solution for that.
One would be to separate content changes and moving/adjusting index into
separate PRs - basically adjust index only after content changes are
merged. Alternatively, do not split individual pages into separate PRs,
but this will make review process longer (no way to merge already
finished pages if other still requires some changes).

The way it is right now will require manual conflict resolution, or
rebasing those PRs once other are merged. Perhaps this is the simplest
option...

> *Plans for next week:*
>
> - Editing Suspend/resume, VM, and HVM Troubleshooting based on PRs
> reviews.
> - Disk troubleshooting
> - PCI troubleshooting
> - USB troubleshooting

Yes, sounds good.
Based on the current review, it may be good to link to some
report/discussion where the particular issue is analysed (if available)
- - this will give more context in case of similar but not exactly the
same problem.

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEEhrpukzGPukRmQqkK24/THMrX1ywFAl+BtloACgkQ24/THMrX
1yziowf/WOhsW39KvQC027FG4edPIU0e4HZnxqRmFsTdp9es0Sc8kd3YeKcPwUAI
HfqqCCtQ6tuH4zfELWAnRcs7CTolAK7gIdY72wMl5aJXNXX7OdC/zj9YOAdNkhj1
/4bm+7Uv7qodxXs79evN2vpgIXibMT+3MHWsfI8Fvo2nQexToln11OLbrIVRPz+N
74R1po4L7Dkigb2Vpu3flH8qZ6+iQrF3mkIKOQIkbqcY30/wkYcp+5g/if9ryjGw
U36iBvbwzUg3yfxQFkdLd5JMEK/5pOkou8iEuWmO6T/ffHPM2lCjt6fNA8/BXl9M
lfEoPgvYYYPcQSDxYMhdy6h4QEcy0g==
=pVf+
-----END PGP SIGNATURE-----

c1e0

unread,
Oct 10, 2020, 10:59:32 AM10/10/20
to qubes-devel
I replied to this via email, thinking the reply will appear here as well. But it hasn't, so I'll repeat my reply here.

> I posted some review comments there.
> As noted there, changes in the doc index like done now will conflict
> between those PRs. I don't know clean _and effective_ solution for that.
> One would be to separate content changes and moving/adjusting index into
> separate PRs - basically adjust index only after content changes are
> merged. Alternatively, do not split individual pages into separate PRs,
> but this will make review process longer (no way to merge already
> finished pages if other still requires some changes).
>
> The way it is right now will require manual conflict resolution, or
> rebasing those PRs once other are merged. Perhaps this is the simplest
> option...

I have been trying to avoid conflicts, but some seem inevitable. Or maybe I'm not trying hard enough.
I won't mind resolving conflicts that'll arise in PRs once other PRs are merged. 

> Yes, sounds good.
> Based on the current review, it may be good to link to some
> report/discussion where the particular issue is analysed (if available)
> - - this will give more context in case of similar but not exactly the
> same problem.

I actually have a pad where I've been recording links to reports/discussions where issues are discussed:  https://pad.riseup.net/p/qubes-doc-keep
I'll start mentioning these reports//discussions in my subsequent updates.

Thanks!
Reply all
Reply to author
Forward
0 new messages