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

docs(client): update Linux and Windows Client docs #5007

Merged
merged 34 commits into from
May 22, 2024
Merged

docs(client): update Linux and Windows Client docs #5007

merged 34 commits into from
May 22, 2024

Conversation

ReactorScram
Copy link
Collaborator

@ReactorScram ReactorScram commented May 16, 2024 •
edited

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

Before merging

Edit tasklist title
Beta Give feedback Tasklist Before merging, more options

Delete tasklist

Delete tasklist block?
Are you sure? All relationships in this tasklist will be removed.
  1. Test Windows GUI instructions
    Options
  2. Add troubleshooting for Linux GUI client disconnected right after connecting. #5027
    Options
  3. Fill in troubleshooting sections
    Options
  4. Test Linux GUI instructions
    Options
  5. Linux headless - Make sure SIGTERM or Ctrl+C or whatever reverts resolv.conf
    Options
  6. Test Linux Headless instructions
    Options
  7. Page descriptions should be "How to install and use the Firezone $OS $UI client."
    Options
  8. Linux headless - Confirm behaviors and default values of all env vars (skipping - The ones that are used are exercised)
    Options
  9. Grep for TODOs
    Options
  10. Change "un-install" to "uninstall"
    Options
  11. Capitalize "Client" where needed
    Options
  12. Change "IPC service" to "Tunnel service" or something
    Options
  13. Change "SplitDNS" to "Split DNS"
    Options
  14. Wait for next Client release to be cut
    Options

@ReactorScram ReactorScram added this to the 06/24 milestone May 16, 2024
@ReactorScram ReactorScram self-assigned this May 16, 2024
@vercel Vercel
Copy link

vercel bot commented May 16, 2024 •
edited

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
firezone ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 22, 2024 8:03pm

@github-actions github-actions bot added the kind/docs Improvements or updates to documentation label May 16, 2024
This was referenced May 16, 2024
Closed
Closed
@github-actions GitHub Actions
Copy link

github-actions bot commented May 16, 2024 •
edited

Terraform Cloud Plan Output

Plan: 15 to add, 15 to change, 15 to destroy.

Terraform Cloud Plan

@github-actions GitHub Actions
Copy link

github-actions bot commented May 16, 2024 •
edited

Performance Test Results

TCP

Test Name Received/s Sent/s Retransmits
direct-tcp-client2server 242.8 MiB (+0%) 244.9 MiB (+0%) 407 (+138%)
direct-tcp-server2client 240.6 MiB (-1%) 242.0 MiB (-1%) 36 (-91%)
relayed-tcp-client2server 228.0 MiB (+0%) 229.0 MiB (+0%) 287 (+30%)
relayed-tcp-server2client 237.7 MiB (-0%) 238.2 MiB (-1%) 453 (+7%)

UDP

Test Name Total/s Jitter Lost
direct-udp-client2server 500.0 MiB (+0%) 0.06ms (+58%) 43.97% (+4%)
direct-udp-server2client 500.0 MiB (-0%) 0.01ms (+21%) 20.58% (-6%)
relayed-udp-client2server 500.0 MiB (+0%) 0.03ms (+29%) 54.72% (-5%)
relayed-udp-server2client 500.0 MiB (+0%) 0.04ms (-53%) 36.70% (-13%)

@ReactorScram ReactorScram changed the base branch from main to docs/add-support-options May 16, 2024 16:04
Base automatically changed from docs/add-support-options to main May 16, 2024 16:29
@ReactorScram ReactorScram changed the base branch from main to build/post-install-script May 16, 2024 19:26
Base automatically changed from build/post-install-script to main May 16, 2024 23:22
@ReactorScram ReactorScram requested a review from jamilbk May 16, 2024 23:23
@ReactorScram
Copy link
Collaborator Author

@jamilbk Does the overall structure look right? I set up the same sections for all 3 pages, mostly filled them in, and changed some "you can download from here" type sentences to imperative, "Download from here".

All that's left is filling in troubleshooting and then testing everything step-by-step, which will take a while and hopefully result in only minor changes.

@jamilbk
Copy link
Member

jamilbk commented May 16, 2024

@ReactorScram Looks great!

@ReactorScram
Copy link
Collaborator Author

I tested the Windows instructions using my Windows Server 2022 VM and the tip of the Windows IPC PR and it works well.

@jamilbk jamilbk enabled auto-merge May 22, 2024 18:03
@jamilbk jamilbk added this pull request to the merge queue May 22, 2024
Merged via the queue into main with commit 2416d4f May 22, 2024
135 checks passed
@jamilbk jamilbk deleted the docs/update-client-docs branch May 22, 2024 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jamilbk jamilbk jamilbk approved these changes

Assignees

@ReactorScram ReactorScram

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