From 2f2ad2cffe278530573e240f5c6e79cb02418aee Mon Sep 17 00:00:00 2001 From: Thomas Eizinger Date: Thu, 5 Dec 2024 00:08:33 +0000 Subject: [PATCH] docs(changelog): remove `enable` attr (#7458) Idiomatic React is to conditionally render the entire element instead of passing down an `enable` attribute. --- .../src/components/Changelog/ChangeItem.tsx | 6 - website/src/components/Changelog/GUI.tsx | 188 +++++++++++------- 2 files changed, 114 insertions(+), 80 deletions(-) diff --git a/website/src/components/Changelog/ChangeItem.tsx b/website/src/components/Changelog/ChangeItem.tsx index 5d8ee6fef..04acac98a 100644 --- a/website/src/components/Changelog/ChangeItem.tsx +++ b/website/src/components/Changelog/ChangeItem.tsx @@ -2,18 +2,12 @@ import Entry from "./Entry"; import Link from "next/link"; export default function ChangeItem({ - enable = true, pull, children, }: { - enable?: boolean; pull?: string; children: React.ReactNode; }) { - if (!enable) { - return null; - } - return (
  • {pull ? ( diff --git a/website/src/components/Changelog/GUI.tsx b/website/src/components/Changelog/GUI.tsx index 29a01af64..3848a350d 100644 --- a/website/src/components/Changelog/GUI.tsx +++ b/website/src/components/Changelog/GUI.tsx @@ -46,36 +46,46 @@ export default function GUI({ title }: { title: string }) { Handles DNS queries over TCP correctly. - - The IPC service `firezone-client-ipc.exe` is now signed. - + {title === "Windows" && ( + + The IPC service `firezone-client-ipc.exe` is now signed. + + )} Reports the version to the Portal correctly. - - Supports Ubuntu 24.04, no longer supports Ubuntu 20.04. - + {title === "Linux GUI" && ( + + Supports Ubuntu 24.04, no longer supports Ubuntu 20.04. + + )} Fixes an issue where Firezone would fail to establish connections to Gateways and the user had to sign-out and in again. - - Fixes a crash on startup caused by incorrect permissions on the ID - file. - - - This is a maintenance release with no user-facing changes. - + {title === "Linux GUI" && ( + + Fixes a crash on startup caused by incorrect permissions on the ID + file. + + )} + {title === "Windows" && ( + + This is a maintenance release with no user-facing changes. + + )} Fixes the GUI shutting down slowly. - - Mitigates an issue where `ipconfig` and WSL weren't aware of Firezone - DNS resolvers. Users may need to restart WSL after signing in to - Firezone. - + {title === "Windows" && ( + + Mitigates an issue where `ipconfig` and WSL weren't aware of + Firezone DNS resolvers. Users may need to restart WSL after signing + in to Firezone. + + )} @@ -89,9 +99,11 @@ export default function GUI({ title }: { title: string }) { Adds always-on error reporting using sentry.io. - - Fixes a delay when closing the GUI. - + {title === "Windows" && ( + + Fixes a delay when closing the GUI. + + )} Tries to send motherboard's hardware ID for device verification. @@ -107,17 +119,21 @@ export default function GUI({ title }: { title: string }) { Fixes an issue where some browsers may fail to route DNS Resources correctly. - - Fixes a bug where the Linux Clients didn't work on ZFS filesystems. - + {title === "Linux GUI" && ( + + Fixes a bug where the Linux Clients didn't work on ZFS filesystems. + + )} Fixes a bug where auto-sign-in with an expired token would cause a "Couldn't send Disconnect" error message. - - Fixes a bug where roaming from Ethernet to WiFi would cause Firezone - to fail to connect to the portal. - + {title === "Windows" && ( + + Fixes a bug where roaming from Ethernet to WiFi would cause Firezone + to fail to connect to the portal. + + )} @@ -133,12 +149,16 @@ export default function GUI({ title }: { title: string }) { - - This is a maintenance release with no user-facing changes. - - - Fixes a bug where sign-in fails if IPv6 is disabled. - + {title === "Linux GUI" && ( + + This is a maintenance release with no user-facing changes. + + )} + {title === "Windows" && ( + + Fixes a bug where sign-in fails if IPv6 is disabled. + + )} @@ -165,10 +185,12 @@ export default function GUI({ title }: { title: string }) { download. Checks for updates once a day - - Fixes an issue where Split DNS didn't work for domain-joined Windows - machines - + {title === "Windows" && ( + + Fixes an issue where Split DNS didn't work for domain-joined Windows + machines + + )} @@ -188,13 +210,17 @@ export default function GUI({ title }: { title: string }) { Implements glob-like matching of domains for DNS resources. - - Fixes a bug where the "Clear Logs" button did not clear the IPC - service logs. - - - Fixes a bug where the GUI could not run if the user is Administrator - + {title === "Windows" && ( + + Fixes a bug where the "Clear Logs" button did not clear the IPC + service logs. + + )} + {title === "Windows" && ( + + Fixes a bug where the GUI could not run if the user is Administrator + + )} The log filter on the IPC service is now reloaded immediately when you change the setting in the GUI. @@ -226,16 +252,18 @@ export default function GUI({ title }: { title: string }) { Adds the ability to mark Resources as favorites. - - Supports using `etc-resolv-conf` DNS control method, or disabling DNS - control - + {title === "Linux GUI" && ( + + Supports using `etc-resolv-conf` DNS control method, or disabling + DNS control + + )} Improves reliability of DNS resolution of non-resources. - - Supports disabling DNS control - + {title === "Windows" && ( + Supports disabling DNS control + )} Mitigates a bug where the IPC service can panic if an internal channel fills up @@ -247,12 +275,14 @@ export default function GUI({ title }: { title: string }) { - - Adds network roaming support. - - - Fixes "Element not found" error when setting routes. - + {title === "Linux GUI" && ( + Adds network roaming support. + )} + {title === "Windows" && ( + + Fixes "Element not found" error when setting routes. + + )} Removes keyboard accelerators, which were not working. @@ -261,33 +291,43 @@ export default function GUI({ title }: { title: string }) { - - Stops the GUI and prompts you to re-launch it if you update Firezone - while the GUI is running. - - - Improves sign-in speed and fixes a DNS leak - + {title === "Linux GUI" && ( + + Stops the GUI and prompts you to re-launch it if you update Firezone + while the GUI is running. + + )} + {title === "Windows" && ( + + Improves sign-in speed and fixes a DNS leak + + )} Unexpected IPC service stops are now reported as "IPC connection closed". - - Fixes a bug where DNS could stop working when you sign out. - + {title === "Windows" && ( + + Fixes a bug where DNS could stop working when you sign out. + + )} Shows different tray icons when signed out, signing in, and signed in. - - The Linux GUI Client is now built for both x86-64 and ARM64. - - - This is a maintenance release with no user-facing changes. - + {title === "Linux GUI" && ( + + The Linux GUI Client is now built for both x86-64 and ARM64. + + )} + {title === "Windows" && ( + + This is a maintenance release with no user-facing changes. + + )}