We are looking for an additional documentation maintainer to help Unman
the current doc maintainer - with the task. The role mainly consists
of reviewing and merging pull requests to the documentation, but
sometimes it’s also about writing/adjusting some parts. The person
should be familiar with Qubes OS enough to be able to verify accuracy of
proposed changes, but they don’t need to know everything - it’s okay to
ask others in case of doubt. The important part is knowing when to ask
Technically, it involves working with git (including signed tags),
markdown files, and (hopefully very soon) reStructuredText (rst) format
and Sphinx.
Since the role includes push access to the qubes-doc repository, we
expect this to be a person, that has already been participating in the
community for a significant time[1].
We understand the value of well-maintained documentation, and to help keep
it sustainable we can provide some remuneration for the maintainer from the
funds we collect on OpenCollective.
If you think you will be a good fit for this role, and would like to
help the project, let us know.
[1] lets say, 3 years, to put the bar higher than xz-utils
I’d be happy to help, however I don’t have the 3 years required. But I’ve done paid work on the documentation for the foundation, so you have a proof I’m a real person at least
No 3 years of being involved, but still would like to volunteer.
In my case the verification of documentation accuracy might be made easier with both the experience I have with reviewing technical documents, e.g. for UEFI Shim signing or with a lab setup, which helps follow text verbatim and see if that text matches, what exactly happens.
I do not have proof of personhood, however I have been using QubesOS since the release of R4.2. I am willing to help with documentation and I have significant free time :3
Thank you all who volunteered! We have received many more candidates
than we could hoped for, and it was not an easy decision to make.
After evaluating all the submissions, we still couldn’t decided on one
person, so in the end we selected two additional maintainers:
Solène Rapenne (rapenne-s (Solène Rapenne) · GitHub). She is an excellent
technical writer, earlier in the OpenBSD community, now in our. She isn’t
here very long, but it’s clear she is a reliable and trustworthy person
based on her past FOSS contributions.
m (maiska (m) · GitHub). She is contributing to Qubes OS’s
documentation for a long time, mostly on the infrastructural level
(markdown files organization, adding language tags, Transifex
integration and many more). She also spent a lot of time preparing
migration to Sphinx / Read the Docs and knows a lot about all the tools
involved. On a more personal note, we have met in person on several
occasions, she is definitely a real person
I hope two additional documentation maintainers will allow us to move
forward with the documentation
I take the opportunity to encourage Qubes OS to contribute to the documentation
Contributing can be easy if you have a GitHub account, you can edit the content online on GitHub, create a commit and submit a pull requests, just click the green buttons It works fine for small changes.
If you contributed in the past and got bored by delays to get something merged or reviewed, it will get better, I hope to see your PRs again
@solene Any holes in the documentation or maybe suggestions where the help is appreciated?
I think it would be nice if somebody would list the topics like dasharo team did. First good issue, or first good documentation PR…
There’s also a “good first issue” label. (None of the current issues are doc issues, but by their nature, doc issues tend to be more accessible for new contributors since they usually don’t require coding knowledge.)
