New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider clearly labeling documentation intended for developers #2498

Closed
jpouellet opened this Issue Dec 8, 2016 · 0 comments

Comments

Projects
None yet
2 participants
@jpouellet
Contributor

jpouellet commented Dec 8, 2016

On Mon, Dec 5, 2016 at 3:40 AM, Zbigniew Łukasiak wrote:

Here is a list of stuff that I got into trouble trying out Qubes.
...
3. Initially I did not understand how can I change the templates. I
thought that to have additional software or to make any special
configuration in a template I need to create a new template and I
started reading the documentation at
https://www.qubes-os.org/doc/qubes-builder/ - that was really
confusing. There are also additional questions that the docs don't
answer, like if the changes in the template will be visible in a vm
based on it and if yes - then when?

I'm in no way qualified to give UX advice, but perhaps docs intended for devs should be clearly signaled as such in the on-line html-rendered doc pages? It seems to me some line of red text at the top and bottom of the content saying so should suffice.

The goal would be to avoid giving the impression to non-technical prospective Qubes users that understanding such things are required for normal use of the system, and perhaps provide links to end-user-targeted docs they may be looking for instead if appropriate?

@andrewdavidwong andrewdavidwong self-assigned this Dec 8, 2016

@andrewdavidwong andrewdavidwong added this to the Documentation/website milestone Dec 8, 2016

andrewdavidwong added a commit to QubesOS/qubesos.github.io that referenced this issue Dec 8, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment