Skip to content
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

Improve organization of installation docs #475

Closed
eloquence opened this issue Jul 19, 2023 · 1 comment · Fixed by #509
Closed

Improve organization of installation docs #475

eloquence opened this issue Jul 19, 2023 · 1 comment · Fixed by #509
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@eloquence
Copy link
Member

Currently we have:

  • minimal instructions for Windows/Mac in the README.md
  • detailed instructions for Linux package repository configuration in INSTALL.md

There are a few issues with this:

  • README.md does not make it sufficiently clear that you need to install Docker for Desktop to use Dangerzone on Mac or Windows. The app itself will warn the user about this, but we should state the prerequisites more clearly upfront. (Docker is mentioned a couple of times in the README, but not in the section with the download/install info.)
  • INSTALL.md only covers Linux, which means that users who land on that guide may assume that Dangerzone is a Linux-only app.
  • INSTALL.md also does not make the prerequisites for Linux clear (i.e. it does not mention Docker or Podman).

I would suggest that we take the following approach:

  • Treat README.md as a "quickstart guide" that summarizes the steps needed on every supported platform
  • Treat INSTALL.md as detailed installation instructions on every supported platform (and that may include reference to secondary installation options, such as Homebrew, which we might omit from the README for reasons of brevity)
@deeplow deeplow added this to the 0.4.2 milestone Jul 19, 2023
deeplow added a commit that referenced this issue Aug 9, 2023
Makes it clear that one needs to install Docker for Desktop to use Dangerzone
on Mac or Windows and Podman on linux. The app itself will warn the user about
this, but we should state the prerequisites more clearly upfront.

Mentions mac and windows in INSTALL.md so that anyone reading this page does
not wrongly assume that Dangerzone is a Linux-only app.

Fixes #475
@deeplow
Copy link
Contributor

deeplow commented Aug 9, 2023

How does #509 look? I think followed your advice mostly. The only thing that I didn't do was moving the homebrew note to INSTALL.md because it felt a bit out of palce there (all the other instructions for mac remained on README).

@deeplow deeplow added the documentation Improvements or additions to documentation label Aug 9, 2023
@deeplow deeplow self-assigned this Aug 9, 2023
deeplow added a commit that referenced this issue Aug 10, 2023
Makes it clear that one needs to install Docker for Desktop to use Dangerzone
on Mac or Windows and Podman on linux. The app itself will warn the user about
this, but we should state the prerequisites more clearly upfront.

Mentions mac and windows in INSTALL.md so that anyone reading this page does
not wrongly assume that Dangerzone is a Linux-only app.

Fixes #475
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants