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

depreciate torvm, add Whonix templates (at minimum whonix-gw) to Qubes installer #1201

Closed
mfc opened this Issue Sep 22, 2015 · 21 comments

Comments

Projects
None yet
6 participants
@mfc
Member

mfc commented Sep 22, 2015

given the issues that users continue to have with torvm (like #1196) and the reduced feature set compared to whonix-gw, I would suggest depreciating torvm in favor of whonix-gw.

the intention of porting whonix to qubes was exactly to do this, I would view this as fulfilling this goal.

to signify this, I would recommend:

  • adding whonix-gw at minimum to the Qubes installer
  • adding whonix-ws to Qubes installer
  • porting whonix template documentation from whonix.org to qubes-os.org
  • remove/redirect/modify torvm documentation to whonix-gw documentation
@adrelanos

This comment has been minimized.

Show comment
Hide comment
@adrelanos

adrelanos Sep 22, 2015

Member

Is it important to move Whonix documentation? I don't see advantages by it. Where does porting whonix.org start, where does it stop? It would likely still have lots of references to whonix.org.

To move to qubes-os.org feels like a step backwards to me. No auto generated table of contents per page. No wiki templates [importing wiki markup from a wiki template]? Less agile and user friendly to anonymous fly-by editors. Git pull requests (qubes-os.org, high bar) vs anonymous wiki edits (whonix.org, very low bar).

Member

adrelanos commented Sep 22, 2015

Is it important to move Whonix documentation? I don't see advantages by it. Where does porting whonix.org start, where does it stop? It would likely still have lots of references to whonix.org.

To move to qubes-os.org feels like a step backwards to me. No auto generated table of contents per page. No wiki templates [importing wiki markup from a wiki template]? Less agile and user friendly to anonymous fly-by editors. Git pull requests (qubes-os.org, high bar) vs anonymous wiki edits (whonix.org, very low bar).

@adrelanos adrelanos referenced this issue Sep 22, 2015

Closed

Port over documentation from third-party sites #1202

12 of 12 tasks complete
@marmarek

This comment has been minimized.

Show comment
Hide comment
@marmarek

marmarek Sep 22, 2015

Member

FWIW I also don't see any sense in moving Whonix documentation to Qubes OS site. It should be on Whonix website (also), and having it duplicated doesn't make sense (will surely lead to synchronization issues).

Maybe we should just have "Whonix quick start" guide and linked to whonix.org for detailed instructions.

Member

marmarek commented Sep 22, 2015

FWIW I also don't see any sense in moving Whonix documentation to Qubes OS site. It should be on Whonix website (also), and having it duplicated doesn't make sense (will surely lead to synchronization issues).

Maybe we should just have "Whonix quick start" guide and linked to whonix.org for detailed instructions.

@bnvk

This comment has been minimized.

Show comment
Hide comment
@bnvk

bnvk Sep 22, 2015

@marmarek from a user experience standpoint, having unified documentation that has a similar style, flow, and terminology is tremendously better. If Whonix was never going to ship with / have the depth of integration with Qubes, then it might not make as much sense, but just seems like a clear huge win to me.

Maybe we should just have "Whonix quick start" guide and linked to whonix.org for detailed instructions

I'm not aiming for superl deep details about how or what Whonix does, but rather clear, short instructions on how to make Whonix work within Qubes!

bnvk commented Sep 22, 2015

@marmarek from a user experience standpoint, having unified documentation that has a similar style, flow, and terminology is tremendously better. If Whonix was never going to ship with / have the depth of integration with Qubes, then it might not make as much sense, but just seems like a clear huge win to me.

Maybe we should just have "Whonix quick start" guide and linked to whonix.org for detailed instructions

I'm not aiming for superl deep details about how or what Whonix does, but rather clear, short instructions on how to make Whonix work within Qubes!

@unman

This comment has been minimized.

Show comment
Hide comment
@unman

unman Sep 22, 2015

Member

@mfc
The issue you cite (#1196) isnt torvm specific - the errors are 404 and 500 errors, just the same as those you'll find cited on the whonix site. These errors are more prevalent when updating through Tor - whether you use torvm, whonix-gw or some other Tor proxy.
It isn't necessary to deprecate torVM to whonix - both should be available for those who want them, and we should recognise that some users wont want either.

Member

unman commented Sep 22, 2015

@mfc
The issue you cite (#1196) isnt torvm specific - the errors are 404 and 500 errors, just the same as those you'll find cited on the whonix site. These errors are more prevalent when updating through Tor - whether you use torvm, whonix-gw or some other Tor proxy.
It isn't necessary to deprecate torVM to whonix - both should be available for those who want them, and we should recognise that some users wont want either.

@mfc

This comment has been minimized.

Show comment
Hide comment
@mfc

mfc Sep 23, 2015

Member

clear, short instructions on how to make Whonix work within Qubes!

exactly! just the "how to install / setup" info, with a link to the whonix webpage for more info. so not moving the documentation, just mirroring/copying a subset of it.

@unman I agree that both should be available to users -- torvm documentation for power users who want to create them and whonix-gw for everyone else. the idea being that instead of splitting dev time on two different implementations of the same thing, we should clearly focus on one (the one with more functionality) and communicate that to the average user. whonix-gw could just be framed as torvm 2.0.

#1196 is just the most recent example of a use-case where torvm does not work as expected while whonix-gw does. marek mentions in that issue some other instances where torvm lacks functionality compared to whonix-gw.

Member

mfc commented Sep 23, 2015

clear, short instructions on how to make Whonix work within Qubes!

exactly! just the "how to install / setup" info, with a link to the whonix webpage for more info. so not moving the documentation, just mirroring/copying a subset of it.

@unman I agree that both should be available to users -- torvm documentation for power users who want to create them and whonix-gw for everyone else. the idea being that instead of splitting dev time on two different implementations of the same thing, we should clearly focus on one (the one with more functionality) and communicate that to the average user. whonix-gw could just be framed as torvm 2.0.

#1196 is just the most recent example of a use-case where torvm does not work as expected while whonix-gw does. marek mentions in that issue some other instances where torvm lacks functionality compared to whonix-gw.

@bnvk

This comment has been minimized.

Show comment
Hide comment
@bnvk

bnvk Sep 25, 2015

@adrelanos to elaborate why I strongly believe in porting over the "Qubes/Whonix specific documentation" from whonix.org since @marmarek also voiced concern not seeing the value in it, I'll further elaborate:

  1. Instead of needing to learn how two different site's information architecture and flow, unifying significantly improves a user's chance of understanding (thus using documentation to reach their goals). Currently, the Qubes docs are already quite decent.
  2. This allows us to bundle the documentation for offline use, which would be very helpful if a user can't get online due to misconfigured / NetVM issues.
  3. This page on the Whonix site is geared towards explaining "why to use Qubes on top of Whonix" which makes little sense for a user coming from the Qubes site as they already use & like Qubes- this info is not what I would consider "documentation" and should stay on the Whonix site as it is aimed at Whonix community.
  4. Numerous parts of that overview page still read "TODO" which seems a bit rough and unfinished.
  5. The Whonix site & docs are poorly organized & designed- a user currently has to scroll 2+ full browser windows to find a bunch of columns and then visually parse "Primary Guides -> Install -> Binary Install Guide" to get to any actionable steps and (even on that page) it is disorienting and requires a full scroll to get to any useful information.

No auto generated table of contents per page. No wiki templates [importing wiki markup from a wiki template]?

Jekyll can totally generate this and it's super easy to do. I see this as a feature and desirable. Wiki syntax & templates are not user friendly or universally the same. And the templates are very hard to style well- see my above notes about the current site design.

  1. Gives us (me) a fresh slate to redesign / improve the Qubes / Whonix documentation as I'm working through that on the site redesign

Does that help clarify make sense to you both? I don't think duplicating this information on both sites makes sense.

As far as @adrelanos point about:

Less agile and user friendly to anonymous fly-by editors. Git pull requests (qubes-os.org, high bar) vs anonymous wiki edits (whonix.org, very low bar).

This can be made quite easy (arguably, much easier than MediaWiki) using prose.io which we can link to or self host (if we ever wanted to do that). Additionally, you can edit through Github's website, which I think is at least on par with MediaWiki's usability. Lastly, i'm going to go out on a limb here and say: people who can probably help us improve the Whonix / Qubes docs are pretty tech saavy and can probably use Git and edit markdown files.

bnvk commented Sep 25, 2015

@adrelanos to elaborate why I strongly believe in porting over the "Qubes/Whonix specific documentation" from whonix.org since @marmarek also voiced concern not seeing the value in it, I'll further elaborate:

  1. Instead of needing to learn how two different site's information architecture and flow, unifying significantly improves a user's chance of understanding (thus using documentation to reach their goals). Currently, the Qubes docs are already quite decent.
  2. This allows us to bundle the documentation for offline use, which would be very helpful if a user can't get online due to misconfigured / NetVM issues.
  3. This page on the Whonix site is geared towards explaining "why to use Qubes on top of Whonix" which makes little sense for a user coming from the Qubes site as they already use & like Qubes- this info is not what I would consider "documentation" and should stay on the Whonix site as it is aimed at Whonix community.
  4. Numerous parts of that overview page still read "TODO" which seems a bit rough and unfinished.
  5. The Whonix site & docs are poorly organized & designed- a user currently has to scroll 2+ full browser windows to find a bunch of columns and then visually parse "Primary Guides -> Install -> Binary Install Guide" to get to any actionable steps and (even on that page) it is disorienting and requires a full scroll to get to any useful information.

No auto generated table of contents per page. No wiki templates [importing wiki markup from a wiki template]?

Jekyll can totally generate this and it's super easy to do. I see this as a feature and desirable. Wiki syntax & templates are not user friendly or universally the same. And the templates are very hard to style well- see my above notes about the current site design.

  1. Gives us (me) a fresh slate to redesign / improve the Qubes / Whonix documentation as I'm working through that on the site redesign

Does that help clarify make sense to you both? I don't think duplicating this information on both sites makes sense.

As far as @adrelanos point about:

Less agile and user friendly to anonymous fly-by editors. Git pull requests (qubes-os.org, high bar) vs anonymous wiki edits (whonix.org, very low bar).

This can be made quite easy (arguably, much easier than MediaWiki) using prose.io which we can link to or self host (if we ever wanted to do that). Additionally, you can edit through Github's website, which I think is at least on par with MediaWiki's usability. Lastly, i'm going to go out on a limb here and say: people who can probably help us improve the Whonix / Qubes docs are pretty tech saavy and can probably use Git and edit markdown files.

@mfc

This comment has been minimized.

Show comment
Hide comment
@mfc

mfc Sep 25, 2015

Member

Just to provide a different but supportive argument, we want the documentation for all the Qubes Templates to be standardized.

So this means not having some Template pages having instructions directly on the webpage and others just having links to external websites or to the Google Groups lists.

This will make sure there is a unified level of quality and instruction for all Templates. It will also make sure the instructions are included in offline documentation #1019 as previously mentioned.

So it's not just something for Whonix Templates, it's something that needs to be done for all Templates documentation.

Member

mfc commented Sep 25, 2015

Just to provide a different but supportive argument, we want the documentation for all the Qubes Templates to be standardized.

So this means not having some Template pages having instructions directly on the webpage and others just having links to external websites or to the Google Groups lists.

This will make sure there is a unified level of quality and instruction for all Templates. It will also make sure the instructions are included in offline documentation #1019 as previously mentioned.

So it's not just something for Whonix Templates, it's something that needs to be done for all Templates documentation.

@adrelanos

This comment has been minimized.

Show comment
Hide comment
@adrelanos

adrelanos Oct 6, 2015

Member

TLDR Whonix documentation moving to Qubes website:

Talked to @bnvk at the Tor summer dev meeting. Agreed to move
Qubes-Whonix quick start instructions to the Qubes website. @bnvk wanted
to take this task. Feel free to reassign the task back to me.

The following long answer is not a rebuttal. Because the reasons for
doing this weight more than reasons not doing this. Skippable. Just for
better mutual understanding.

Long:

Brennan Novak:

@marmarek from a user experience standpoint, having unified
documentation that has a similar style, flow, and terminology is
tremendously better. If Whonix was never going to ship with / have
the depth of integration with Qubes, then it might not make as much
sense, but just seems like a clear huge win to me.

Ok.

Maybe we should just have "Whonix quick start" guide and linked to
whonix.org for detailed instructions

I'm not aiming for superl deep details about how or what Whonix does,
but rather clear, short instructions on how to make Whonix work
within Qubes!

Ok.

Brennan Novak:

  1. Instead of needing to learn how two different site's information
    architecture and flow, unifying significantly improves a user's
    chance of understanding (thus using documentation to reach their
    goals). Currently, the Qubes docs are already quite decent.
  2. This allows us to bundle the documentation for offline use, which
    would be very helpful if a user can't get online due to misconfigured
    / NetVM issues.

Ok.

  1. This page on the Whonix site
    is geared towards explaining "why to use Qubes on top of Whonix"
    which makes little sense for a user coming from the Qubes site as
    they already use & like Qubes- this info is not what I would
    consider "documentation" and should stay on the Whonix site
    as it is
    aimed at Whonix community.

This would be a non-reason: because it would be easier to fix the page.

  1. Numerous parts of that overview page still read "TODO" which seems
    a bit rough and unfinished.

[The TODO's were there to advertise/encourage contributions for lower
priority items.]

This would be a non-reason: because it would be easier to fix the page.

  1. The Whonix site & docs are poorly organized & designed- a user
    currently has to scroll 2+ full browser windows to find a bunch of
    columns and then visually parse "Primary Guides -> Install ->
    Binary Install Guide"
    to get to any actionable steps and (even on
    that page) it is disorienting and requires a full scroll to get to
    any useful information.

This would be a non-reason: because it would be easier to fix the page.

No auto generated table of contents per page. No wiki templates
[importing wiki markup from a wiki template]?

Jekyll can totally generate this and it's super easy to do. I see
this as a feature and desirable. Wiki syntax & templates are not user
friendly or universally the same. And the templates are very hard to
style well- see my above notes about the current site design.

Need a ticket for that.

  1. Gives us (me) a fresh slate to redesign / improve the Qubes /
    Whonix documentation as I'm working through that on the site
    redesign

Ok.

Does that help clarify make sense to you both? I don't think
duplicating this information on both sites makes sense.

Yes.

As far as @adrelanos point about:

Less agile and user friendly to anonymous fly-by editors. Git pull
requests (qubes-os.org, high bar) vs anonymous wiki edits
(whonix.org, very low bar).

This can be made quite easy (arguably, much easier than MediaWiki)
using prose.io which we can link to or self host
(if we ever wanted to do that). Additionally, you can edit through
Github's website, which I think is at least on par with MediaWiki's
usability.

These are workarounds and not as obvious and encouraging as MediaWiki's
EDIT button. The ability of editing MediaWiki is somewhat popular thanks
to Wikipedia.

Lastly, i'm going to go out on a limb here and say: people
who can probably help us improve the Whonix / Qubes docs are pretty
tech saavy and can probably use Git and edit markdown files.

Experience with Whonix development has shown, that this is not the case.
Two examples coming to my mind first:

Member

adrelanos commented Oct 6, 2015

TLDR Whonix documentation moving to Qubes website:

Talked to @bnvk at the Tor summer dev meeting. Agreed to move
Qubes-Whonix quick start instructions to the Qubes website. @bnvk wanted
to take this task. Feel free to reassign the task back to me.

The following long answer is not a rebuttal. Because the reasons for
doing this weight more than reasons not doing this. Skippable. Just for
better mutual understanding.

Long:

Brennan Novak:

@marmarek from a user experience standpoint, having unified
documentation that has a similar style, flow, and terminology is
tremendously better. If Whonix was never going to ship with / have
the depth of integration with Qubes, then it might not make as much
sense, but just seems like a clear huge win to me.

Ok.

Maybe we should just have "Whonix quick start" guide and linked to
whonix.org for detailed instructions

I'm not aiming for superl deep details about how or what Whonix does,
but rather clear, short instructions on how to make Whonix work
within Qubes!

Ok.

Brennan Novak:

  1. Instead of needing to learn how two different site's information
    architecture and flow, unifying significantly improves a user's
    chance of understanding (thus using documentation to reach their
    goals). Currently, the Qubes docs are already quite decent.
  2. This allows us to bundle the documentation for offline use, which
    would be very helpful if a user can't get online due to misconfigured
    / NetVM issues.

Ok.

  1. This page on the Whonix site
    is geared towards explaining "why to use Qubes on top of Whonix"
    which makes little sense for a user coming from the Qubes site as
    they already use & like Qubes- this info is not what I would
    consider "documentation" and should stay on the Whonix site
    as it is
    aimed at Whonix community.

This would be a non-reason: because it would be easier to fix the page.

  1. Numerous parts of that overview page still read "TODO" which seems
    a bit rough and unfinished.

[The TODO's were there to advertise/encourage contributions for lower
priority items.]

This would be a non-reason: because it would be easier to fix the page.

  1. The Whonix site & docs are poorly organized & designed- a user
    currently has to scroll 2+ full browser windows to find a bunch of
    columns and then visually parse "Primary Guides -> Install ->
    Binary Install Guide"
    to get to any actionable steps and (even on
    that page) it is disorienting and requires a full scroll to get to
    any useful information.

This would be a non-reason: because it would be easier to fix the page.

No auto generated table of contents per page. No wiki templates
[importing wiki markup from a wiki template]?

Jekyll can totally generate this and it's super easy to do. I see
this as a feature and desirable. Wiki syntax & templates are not user
friendly or universally the same. And the templates are very hard to
style well- see my above notes about the current site design.

Need a ticket for that.

  1. Gives us (me) a fresh slate to redesign / improve the Qubes /
    Whonix documentation as I'm working through that on the site
    redesign

Ok.

Does that help clarify make sense to you both? I don't think
duplicating this information on both sites makes sense.

Yes.

As far as @adrelanos point about:

Less agile and user friendly to anonymous fly-by editors. Git pull
requests (qubes-os.org, high bar) vs anonymous wiki edits
(whonix.org, very low bar).

This can be made quite easy (arguably, much easier than MediaWiki)
using prose.io which we can link to or self host
(if we ever wanted to do that). Additionally, you can edit through
Github's website, which I think is at least on par with MediaWiki's
usability.

These are workarounds and not as obvious and encouraging as MediaWiki's
EDIT button. The ability of editing MediaWiki is somewhat popular thanks
to Wikipedia.

Lastly, i'm going to go out on a limb here and say: people
who can probably help us improve the Whonix / Qubes docs are pretty
tech saavy and can probably use Git and edit markdown files.

Experience with Whonix development has shown, that this is not the case.
Two examples coming to my mind first:

@marmarek

This comment has been minimized.

Show comment
Hide comment
@marmarek

marmarek Oct 6, 2015

Member

On Tue, Oct 06, 2015 at 11:06:27AM -0700, Patrick Schleizer wrote:

As far as @adrelanos point about:

Less agile and user friendly to anonymous fly-by editors. Git pull
requests (qubes-os.org, high bar) vs anonymous wiki edits
(whonix.org, very low bar).

This can be made quite easy (arguably, much easier than MediaWiki)
using prose.io which we can link to or self host
(if we ever wanted to do that). Additionally, you can edit through
Github's website, which I think is at least on par with MediaWiki's
usability.

These are workarounds and not as obvious and encouraging as MediaWiki's
EDIT button. The ability of editing MediaWiki is somewhat popular thanks
to Wikipedia.

Lastly, i'm going to go out on a limb here and say: people
who can probably help us improve the Whonix / Qubes docs are pretty
tech saavy and can probably use Git and edit markdown files.

Experience with Whonix development has shown, that this is not the case.
Two examples coming to my mind first:

Somehow offtopic, but we had "edit" button on doc pages, linked to
github built-in editor.

QubesOS/qubesos.github.io@e87babd

Maybe we should restore it? @bnvk, what do you think?

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?

Member

marmarek commented Oct 6, 2015

On Tue, Oct 06, 2015 at 11:06:27AM -0700, Patrick Schleizer wrote:

As far as @adrelanos point about:

Less agile and user friendly to anonymous fly-by editors. Git pull
requests (qubes-os.org, high bar) vs anonymous wiki edits
(whonix.org, very low bar).

This can be made quite easy (arguably, much easier than MediaWiki)
using prose.io which we can link to or self host
(if we ever wanted to do that). Additionally, you can edit through
Github's website, which I think is at least on par with MediaWiki's
usability.

These are workarounds and not as obvious and encouraging as MediaWiki's
EDIT button. The ability of editing MediaWiki is somewhat popular thanks
to Wikipedia.

Lastly, i'm going to go out on a limb here and say: people
who can probably help us improve the Whonix / Qubes docs are pretty
tech saavy and can probably use Git and edit markdown files.

Experience with Whonix development has shown, that this is not the case.
Two examples coming to my mind first:

Somehow offtopic, but we had "edit" button on doc pages, linked to
github built-in editor.

QubesOS/qubesos.github.io@e87babd

Maybe we should restore it? @bnvk, what do you think?

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?

@adrelanos

This comment has been minimized.

Show comment
Hide comment
@adrelanos

adrelanos Oct 6, 2015

Member
Member

adrelanos commented Oct 6, 2015

@bnvk

This comment has been minimized.

Show comment
Hide comment
@bnvk

bnvk Oct 9, 2015

Somehow offtopic, but we had "edit" button on doc pages, linked to github built-in editor

Yes! I'm a big fan of this thing!

bnvk commented Oct 9, 2015

Somehow offtopic, but we had "edit" button on doc pages, linked to github built-in editor

Yes! I'm a big fan of this thing!

@marmarek

This comment has been minimized.

Show comment
Hide comment
@marmarek

marmarek Oct 9, 2015

Member

On Fri, Oct 09, 2015 at 09:37:59AM -0700, Brennan Novak wrote:

Somehow offtopic, but we had "edit" button on doc pages, linked to github built-in editor

Yes! I'm a big fan of this thing!

Can you provide some design for it? Especially where it should be placed
in our current page layout. Most preferably just some patch for the
layout, with '' tag, which I would fill with the correct address.
The button we had previously looked awful and this was the reason for
removing it.

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?

Member

marmarek commented Oct 9, 2015

On Fri, Oct 09, 2015 at 09:37:59AM -0700, Brennan Novak wrote:

Somehow offtopic, but we had "edit" button on doc pages, linked to github built-in editor

Yes! I'm a big fan of this thing!

Can you provide some design for it? Especially where it should be placed
in our current page layout. Most preferably just some patch for the
layout, with '' tag, which I would fill with the correct address.
The button we had previously looked awful and this was the reason for
removing it.

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?

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Oct 11, 2015

Member

Experience with Whonix development has shown, that this is not the case. Two examples coming to my mind first: [...]

@adrelanos, do you remember the old TracWiki site? Are you thinking that moving away from that system (and to the current Git-based doc system) was a bad move?

Member

andrewdavidwong commented Oct 11, 2015

Experience with Whonix development has shown, that this is not the case. Two examples coming to my mind first: [...]

@adrelanos, do you remember the old TracWiki site? Are you thinking that moving away from that system (and to the current Git-based doc system) was a bad move?

@adrelanos

This comment has been minimized.

Show comment
Hide comment
@adrelanos

adrelanos Oct 11, 2015

Member

@adrelanos, do you remember the old TracWiki site?

Yes.

Are you thinking that moving away from that system (and to the current Git-based doc system) was a bad move?

I think the trac issue tracker is better suited than github issues for a project of this size. For the website I am not sure. While trac wiki makes contributions simpler (edit/preview/save buttons), the new website looks better than trac wiki. For websites of Libre Software projects I prefer mediawiki as content generator. It's the best tool for accepting contributions and has the lowest bar for editing. You can even accept anonymous edits by moderating those (extension: flagged revisions). The mediawiki default skin looks awful indeed. But you can make mediawiki look like just a normal website. See these skins http://www.mediawikibootstrapskin.co.uk.

Member

adrelanos commented Oct 11, 2015

@adrelanos, do you remember the old TracWiki site?

Yes.

Are you thinking that moving away from that system (and to the current Git-based doc system) was a bad move?

I think the trac issue tracker is better suited than github issues for a project of this size. For the website I am not sure. While trac wiki makes contributions simpler (edit/preview/save buttons), the new website looks better than trac wiki. For websites of Libre Software projects I prefer mediawiki as content generator. It's the best tool for accepting contributions and has the lowest bar for editing. You can even accept anonymous edits by moderating those (extension: flagged revisions). The mediawiki default skin looks awful indeed. But you can make mediawiki look like just a normal website. See these skins http://www.mediawikibootstrapskin.co.uk.

@marmarek

This comment has been minimized.

Show comment
Hide comment
@marmarek

marmarek Oct 12, 2015

Member

On Sun, Oct 11, 2015 at 04:15:07AM -0700, Patrick Schleizer wrote:

I think the trac issue tracker is better suited than github issues for a project of this size.

I don't think so. There were two major problems with trac:

  1. Poor / lack of multiple repositories support. We can't refer easily
    from tickets to code (other than manually pasting links) and from code
    to tickets (links, closing tickets). When you forget to paste a link in
    the ticket, later it require some time to search for all the commits
    related to a given ticket.
  2. Really poor anti-spam mechanisms. This was a main reason why we
    had no open registration there (which require additional labor, like
    copy&paste bug reports). When we've tried to open the registration, with
    everything trac offed (CAPTCHA, moderation etc), we've got a tons of
    spam tickets, spam users creation requests and so on. Another issue of
    similar type was DoS attacks. This probably applies to any self-hosted,
    user-editable service. But the great thing about github is that it isn't
    our problem now!

I'm not saying that github issues is the best tool in the world. Just
saying it's better than trac.

As for the website, I don't have any strong opinion. Great thing about
github paget is that it's backed by git repository, which nicely fit in
our not-trusting-the-infrastructure attitude. But we've also done the
same with trac. And probably can be done with any other tool.

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?

Member

marmarek commented Oct 12, 2015

On Sun, Oct 11, 2015 at 04:15:07AM -0700, Patrick Schleizer wrote:

I think the trac issue tracker is better suited than github issues for a project of this size.

I don't think so. There were two major problems with trac:

  1. Poor / lack of multiple repositories support. We can't refer easily
    from tickets to code (other than manually pasting links) and from code
    to tickets (links, closing tickets). When you forget to paste a link in
    the ticket, later it require some time to search for all the commits
    related to a given ticket.
  2. Really poor anti-spam mechanisms. This was a main reason why we
    had no open registration there (which require additional labor, like
    copy&paste bug reports). When we've tried to open the registration, with
    everything trac offed (CAPTCHA, moderation etc), we've got a tons of
    spam tickets, spam users creation requests and so on. Another issue of
    similar type was DoS attacks. This probably applies to any self-hosted,
    user-editable service. But the great thing about github is that it isn't
    our problem now!

I'm not saying that github issues is the best tool in the world. Just
saying it's better than trac.

As for the website, I don't have any strong opinion. Great thing about
github paget is that it's backed by git repository, which nicely fit in
our not-trusting-the-infrastructure attitude. But we've also done the
same with trac. And probably can be done with any other tool.

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?

@mfc

This comment has been minimized.

Show comment
Hide comment
@mfc

mfc Oct 21, 2015

Member

Talked to @bnvk at the Tor summer dev meeting. Agreed to move
Qubes-Whonix quick start instructions to the Qubes website. @bnvk wanted
to take this task. Feel free to reassign the task back to me.

What's the status of this? @bnvk @adrelanos

tired of folks emailing qubes-users failing at setting up torvm, not realizing whonix-gw exists. maybe we need to rename whonix-gw as torvm and just replace torvm documentation entirely.

Member

mfc commented Oct 21, 2015

Talked to @bnvk at the Tor summer dev meeting. Agreed to move
Qubes-Whonix quick start instructions to the Qubes website. @bnvk wanted
to take this task. Feel free to reassign the task back to me.

What's the status of this? @bnvk @adrelanos

tired of folks emailing qubes-users failing at setting up torvm, not realizing whonix-gw exists. maybe we need to rename whonix-gw as torvm and just replace torvm documentation entirely.

@adrelanos

This comment has been minimized.

Show comment
Hide comment
@adrelanos

adrelanos Oct 21, 2015

Member

Michael Carbone:

Talked to @bnvk at the Tor summer dev meeting. Agreed to move
Qubes-Whonix quick start instructions to the Qubes website. @bnvk
wanted to take this task. Feel free to reassign the task back to me.

What's the status of this? @bnvk @adrelanos

Unchanged. I am waiting for @bnvk. Or I take the task back if @bnvk no
longer wants it.

tired of folks emailing qubes-users failing at setting up torvm, not
realizing whonix-gw exists. maybe we need to rename whonix-gw as
torvm and just replace torvm documentation entirely.

Not a good idea for many reasons:

  • it might confuse less the new TorVM users, but confuse more the
    existing TorVM users
  • it would confuse the existing TorVM users, where the old TorVM is gone
  • TorVM is perhaps more popular in the Qubes world, but overall Whonix
    is much more popular
  • don't use project names with 'tor' in their name, as soon as the
    project gains popularity, TPO will complain about trademark violation.
    Speaking from experience. That's why TorBOX (original project name) was
    renamed to Whonix. It would have never come to my mind to rename to
    Whonix, if they didn't complain. -
    https://www.whonix.org/wiki/Dev/TPO_Trademark
Member

adrelanos commented Oct 21, 2015

Michael Carbone:

Talked to @bnvk at the Tor summer dev meeting. Agreed to move
Qubes-Whonix quick start instructions to the Qubes website. @bnvk
wanted to take this task. Feel free to reassign the task back to me.

What's the status of this? @bnvk @adrelanos

Unchanged. I am waiting for @bnvk. Or I take the task back if @bnvk no
longer wants it.

tired of folks emailing qubes-users failing at setting up torvm, not
realizing whonix-gw exists. maybe we need to rename whonix-gw as
torvm and just replace torvm documentation entirely.

Not a good idea for many reasons:

  • it might confuse less the new TorVM users, but confuse more the
    existing TorVM users
  • it would confuse the existing TorVM users, where the old TorVM is gone
  • TorVM is perhaps more popular in the Qubes world, but overall Whonix
    is much more popular
  • don't use project names with 'tor' in their name, as soon as the
    project gains popularity, TPO will complain about trademark violation.
    Speaking from experience. That's why TorBOX (original project name) was
    renamed to Whonix. It would have never come to my mind to rename to
    Whonix, if they didn't complain. -
    https://www.whonix.org/wiki/Dev/TPO_Trademark
@bnvk

This comment has been minimized.

Show comment
Hide comment
@bnvk

bnvk Oct 21, 2015

@mfc @adrelanos i'll take a stab at this as I've got a couple
other Doc patches in my local git + it was my idea :)

I'm thinking we make a separate heading on the Docs ToC for this
such as:

  • Privacy Guides
  • Privacy & Anonymization Guides
  • Anonymizing Yourself Online

bnvk commented Oct 21, 2015

@mfc @adrelanos i'll take a stab at this as I've got a couple
other Doc patches in my local git + it was my idea :)

I'm thinking we make a separate heading on the Docs ToC for this
such as:

  • Privacy Guides
  • Privacy & Anonymization Guides
  • Anonymizing Yourself Online
@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Oct 22, 2015

Member

I'm thinking we make a separate heading on the Docs ToC for this such as:

  • Privacy Guides
  • Privacy & Anonymization Guides
  • Anonymizing Yourself Online

A new section on the /docs/ page would be fine as long as there are enough pages under it to justify having it as a separate section.

I would go with "Privacy Guides" rather than the anything with "Anonymization" in the title, because often what you're talking about isn't actually anonymity but pseudonymity (or some other form of *nymity).

Member

andrewdavidwong commented Oct 22, 2015

I'm thinking we make a separate heading on the Docs ToC for this such as:

  • Privacy Guides
  • Privacy & Anonymization Guides
  • Anonymizing Yourself Online

A new section on the /docs/ page would be fine as long as there are enough pages under it to justify having it as a separate section.

I would go with "Privacy Guides" rather than the anything with "Anonymization" in the title, because often what you're talking about isn't actually anonymity but pseudonymity (or some other form of *nymity).

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

autoupdate: _doc
_doc:
    tag mm_b079a3b7
    tagger Marek Marczykowski-Górecki <marmarek@invisiblethingslab.com> 1449588545 +0100

    Tag for commit b079a3b70547039980289dc780e49cde4fc405a8
    gpg: Signature made Tue 08 Dec 2015 04:29:07 PM CET using RSA key ID 9684938A
    gpg: Good signature from "Marek Marczykowski-Górecki (Qubes Documentation Signing Key) <marmarek@invisiblethingslab.com>"

    b079a3b Merge remote-tracking branch 'origin/pr/62'
    1ae209a moved Getting Started & Research to site repo QubesOS/qubes-issues#1460
    40c1312 fixed Privacy Guides heading QubesOS/qubes-issues#1202
    84c1a0c fixed merge conflict QubesOS/qubes-issues#1202
    c956a2c saved changes to Doc index as QubesOS/qubes-issues#1202
    c7aa41b started porting over Whonix documentation QubesOS/qubes-issues#1201 QubesOS/qubes-issues#1202
    554e5fd harmonized names for 'Resizing' things and improved Root Disk Size (QubesOS/qubes-issues#1441)
    015758b fixed link to Template Whonix and Doc ToC
    763abfb added Privacy section, moved TorVM & VPN there
    25a2fc0 Merge branch 'upstream'
    fb107c1 fixed markdown on resize-root-disk-image

@marmarek marmarek added this to the Documentation/website milestone Jan 7, 2016

@mfc mfc referenced this issue in QubesOS/qubes-doc Feb 19, 2016

Merged

fixed link to Whonix, called torvm depreciated #108

@marmarek

This comment has been minimized.

Show comment
Hide comment
@marmarek

marmarek Feb 28, 2016

Member

Does the commit QubesOS/qubes-doc#108 mean it is finished ?

Member

marmarek commented Feb 28, 2016

Does the commit QubesOS/qubes-doc#108 mean it is finished ?

@mfc

This comment has been minimized.

Show comment
Hide comment
@mfc

mfc Mar 2, 2016

Member

yep let's call it done. hurrah!

Member

mfc commented Mar 2, 2016

yep let's call it done. hurrah!

@mfc mfc closed this Mar 2, 2016

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