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.

Sign up for GitHub

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

Jump to bottom

Linux GUI client docs #4925

Closed
Tracked by #4963
jamilbk opened this issue May 8, 2024 · 0 comments · Fixed by #5007
Closed
Tracked by #4963

Linux GUI client docs #4925

jamilbk opened this issue May 8, 2024 · 0 comments · Fixed by #5007
Assignees
@jamilbk @ReactorScram
Labels
kind/docs Improvements or updates to documentation
Milestone
06/24

Comments

@jamilbk
Copy link
Member

jamilbk commented May 8, 2024

Update /kb/user-guides/linux-client with GUI client instructions, requirements, etc
@jamilbk jamilbk self-assigned this May 8, 2024
@jamilbk jamilbk added the kind/docs Improvements or updates to documentation label May 8, 2024
@jamilbk jamilbk added this to the 06/24 milestone May 8, 2024
This was referenced May 8, 2024
Closed
Closed
This was referenced May 15, 2024
Closed
Open
@ReactorScram ReactorScram mentioned this issue May 16, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 22, 2024
@ReactorScram @jamilbk
docs(client): update Linux and Windows Client docs (#5007)
2416d4f 
Closes #4995
Closes #4925
Closes #4997
Closes #5047 
Supersedes #4965 and #5004.

NOT changing:

- Page description for other Clients. That is still "Firezone
Documentation"

Need these Clients:

- Windows GUI
- Linux headless 
- Linux GUI

to have these things documented: (with exact terms)

- Prerequisites
- Installation
- Usage
  - Signing in
  - Accessing a Resource
  - Signing out
  - Quitting
- Upgrading
- Diagnostic logs
- Uninstalling
- Troubleshooting
  - DNS not reverted after exit
  - DNS Resource not accessible
- Known issues

```[tasklist]
### Before merging
- [x] Test Windows GUI instructions
- [x] Add troubleshooting for #5027
- [x] Fill in troubleshooting sections
- [x] Test Linux GUI instructions
- [x] Linux headless - Make sure SIGTERM or Ctrl+C or whatever reverts resolv.conf
- [x] Test Linux Headless instructions
- [x] Page descriptions should be "How to install and use the Firezone $OS $UI client."
- [x] ~~Linux headless - Confirm behaviors and default values of all env vars~~ (skipping - The ones that are used are exercised)
- [x] Grep for TODOs
- [x] Change "un-install" to "uninstall"
- [x] Capitalize "Client" where needed
- [x] Change "IPC service" to "Tunnel service" or something
- [x] Change "SplitDNS" to "Split DNS"
- [ ] Wait for next Client release to be cut
```

---------

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
Signed-off-by: Reactor Scram <ReactorScram@users.noreply.github.com>
Co-authored-by: Jamil Bou Kheir <jamilbk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jamilbk jamilbk

@ReactorScram ReactorScram

Labels
kind/docs Improvements or updates to documentation
Projects
None yet
Milestone
06/24
2 participants
@jamilbk @ReactorScram