Docs: Refactoring / Cleanup / new links

BornToBeRoot · Dec 31, 2023 · f37adaa · f37adaa
1 parent 9e2bc7c
commit f37adaa
Show file tree

Hide file tree

Showing 23 changed files with 314 additions and 79 deletions.
diff --git a/Source/NETworkManager.Documentation/DocumentationManager.cs b/Source/NETworkManager.Documentation/DocumentationManager.cs
@@ -20,55 +20,125 @@ public static class DocumentationManager
     /// <summary>
     ///     List with all known documentation entries.
     /// </summary>
-    private static List<DocumentationInfo> List => new()
-    {
-        new DocumentationInfo(DocumentationIdentifier.ApplicationDashboard, @"Documentation/Application/Dashboard"),
+    private static IEnumerable<DocumentationInfo> List =>
+    [
+        new DocumentationInfo(DocumentationIdentifier.ApplicationDashboard, 
+            @"docs/application/dashboard"),
+
         new DocumentationInfo(DocumentationIdentifier.ApplicationNetworkInterface,
-            @"Documentation/Application/NetworkInterface"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationWiFi, @"Documentation/Application/WiFi"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationIPScanner, @"Documentation/Application/IPScanner"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationPortScanner, @"Documentation/Application/PortScanner"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationPingMonitor, @"Documentation/Application/PingMonitor"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationTraceroute, @"Documentation/Application/Traceroute"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationDnsLookup, @"Documentation/Application/DNSLookup"),
+            @"docs/application/network-interface"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationWiFi, 
+            @"docs/application/wifi"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationIPScanner, 
+            @"docs/application/ip-scanner"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationPortScanner, 
+            @"docs/application/port-scanner"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationPingMonitor, 
+            @"docs/application/ping-monitor"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationTraceroute, 
+            @"docs/application/traceroute"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationDnsLookup, 
+            @"docs/application/dns-lookup"),
+
         new DocumentationInfo(DocumentationIdentifier.ApplicationRemoteDesktop,
-            @"Documentation/Application/RemoteDesktop"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationPowerShell, @"Documentation/Application/PowerShell"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationPutty, @"Documentation/Application/PuTTY"),
+            @"docs/application/remote-desktop"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationPowerShell, 
+            @"docs/application/powershell"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationPutty, 
+            @"docs/application/putty"),
+
         new DocumentationInfo(DocumentationIdentifier.ApplicationAWSSessionManager,
-            @"Documentation/Application/AWSSessionManager"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationTigerVNC, @"Documentation/Application/TigerVNC"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationWebConsole, @"Documentation/Application/WebConsole"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationSnmp, @"Documentation/Application/SNMP"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationSntpLookup, @"Documentation/Application/SNTPLookup"),
+            @"docs/application/aws-session-manager"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationTigerVNC, 
+            @"docs/application/tigervnc"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationWebConsole, 
+            @"docs/application/web-console"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationSnmp, 
+            @"docs/application/snmp"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationSntpLookup,
+            @"docs/application/sntp-lookup"),
+
         new DocumentationInfo(DocumentationIdentifier.ApplicationDiscoveryProtocol,
-            @"Documentation/Application/DiscoveryProtocol"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationWakeOnLan, @"Documentation/Application/WakeOnLAN"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationWhois, @"Documentation/Application/Whois"),
+            @"docs/application/discovery-protocol"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationWakeOnLan, 
+            @"docs/application/wake-on-lan"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationWhois, 
+            @"docs/application/whois"),
+
         new DocumentationInfo(DocumentationIdentifier.ApplicationIPGeolocation,
-            @"Documentation/Application/IPGeolocation"),
+            @"docs/application/ip-geolocation"),
+
         new DocumentationInfo(DocumentationIdentifier.ApplicationSubnetCalculator,
-            @"Documentation/Application/SubnetCalculator"),
+            @"docs/application/subnet-calculator"),
+
         new DocumentationInfo(DocumentationIdentifier.ApplicationBitCalculator,
-            @"Documentation/Application/BitCalculator"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationLookup, @"Documentation/Application/Lookup"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationConnections, @"Documentation/Application/Connection"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationListeners, @"Documentation/Application/Listeners"),
-        new DocumentationInfo(DocumentationIdentifier.ApplicationArpTable, @"Documentation/Application/ARPTable"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsGeneral, @"Documentation/Settings/General"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsWindow, @"Documentation/Settings/Window"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsAppearance, @"Documentation/Settings/Appearance"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsLanguage, @"Documentation/Settings/Language"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsNetwork, @"Documentation/Settings/Network"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsStatus, @"Documentation/Settings/Status"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsHotKeys, @"Documentation/Settings/HotKeys"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsAutostart, @"Documentation/Settings/Autostart"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsUpdate, @"Documentation/Settings/Update"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsProfiles, @"Documentation/Settings/Profiles"),
-        new DocumentationInfo(DocumentationIdentifier.SettingsSettings, @"Documentation/Settings/Settings"),
-        new DocumentationInfo(DocumentationIdentifier.Profiles, @"Documentation/Profiles"),
-        new DocumentationInfo(DocumentationIdentifier.CommandLineArguments, @"Documentation/CommandLineArguments")
-    };
+            @"docs/application/bit-calculator"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationLookup, 
+            @"docs/application/lookup"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationConnections, 
+            @"docs/application/connection"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationListeners, 
+            @"docs/application/listeners"),
+
+        new DocumentationInfo(DocumentationIdentifier.ApplicationArpTable, 
+            @"docs/application/arp-table"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsGeneral, 
+            @"docs/settings/general"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsWindow, 
+            @"docs/settings/window"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsAppearance, 
+            @"docs/settings/appearance"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsLanguage, 
+            @"docs/settings/language"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsNetwork, 
+            @"docs/settings/network"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsStatus, 
+            @"docs/settings/status"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsHotKeys, 
+            @"docs/settings/hotkeys"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsAutostart, 
+            @"docs/settings/autostart"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsUpdate, 
+            @"docs/settings/update"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsProfiles, 
+            @"docs/settings/profiles"),
+
+        new DocumentationInfo(DocumentationIdentifier.SettingsSettings, 
+            @"docs/settings/settings"),
+
+        new DocumentationInfo(DocumentationIdentifier.Profiles, 
+            @"Documentation/profiles"),
+
+        new DocumentationInfo(DocumentationIdentifier.CommandLineArguments, 
+            @"docs/commandline-arguments")
+    ];
 
     /// <summary>
     ///     Command to open a documentation page based on <see cref="DocumentationIdentifier" />.

diff --git a/Source/NETworkManager.sln.DotSettings b/Source/NETworkManager.sln.DotSettings
@@ -85,6 +85,7 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Subnetting/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Supernetting/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=tabablz/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=tigervnc/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Transifex/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Twork/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Userpass/@EntryIndexedValue">True</s:Boolean>

diff --git a/Website/docs/application/arptable.md → Website/docs/application/arp-table.md b/Website/docs/application/arptable.md → Website/docs/application/arp-table.md
diff --git a/...ite/docs/application/awssessionmanager.md → ...e/docs/application/aws-session-manager.md b/...ite/docs/application/awssessionmanager.md → ...e/docs/application/aws-session-manager.md
diff --git a/Website/docs/application/bitcalculator.md → Website/docs/application/bit-calculator.md b/Website/docs/application/bitcalculator.md → Website/docs/application/bit-calculator.md
diff --git a/...ite/docs/application/discoveryprotocol.md → ...te/docs/application/discovery-protocol.md b/...ite/docs/application/discoveryprotocol.md → ...te/docs/application/discovery-protocol.md
diff --git a/Website/docs/application/dnslookup.md → Website/docs/application/dns-lookup.md b/Website/docs/application/dnslookup.md → Website/docs/application/dns-lookup.md
diff --git a/Website/docs/application/ipscanner.md → Website/docs/application/ip-scanner.md b/Website/docs/application/ipscanner.md → Website/docs/application/ip-scanner.md
diff --git a/Website/docs/application/networkinterface.md → ...ite/docs/application/network-interface.md b/Website/docs/application/networkinterface.md → ...ite/docs/application/network-interface.md
diff --git a/Website/docs/application/pingmonitor.md → Website/docs/application/ping-monitor.md b/Website/docs/application/pingmonitor.md → Website/docs/application/ping-monitor.md
diff --git a/Website/docs/application/portscanner.md → Website/docs/application/port-scanner.md b/Website/docs/application/portscanner.md → Website/docs/application/port-scanner.md
diff --git a/Website/docs/application/remotedesktop.md → Website/docs/application/remote-desktop.md b/Website/docs/application/remotedesktop.md → Website/docs/application/remote-desktop.md
diff --git a/Website/docs/application/sntplookup.md → Website/docs/application/sntp-lookup.md b/Website/docs/application/sntplookup.md → Website/docs/application/sntp-lookup.md
diff --git a/Website/docs/application/subnetcalculator.md → ...ite/docs/application/subnet-calculator.md b/Website/docs/application/subnetcalculator.md → ...ite/docs/application/subnet-calculator.md
diff --git a/Website/docs/application/wakeonlan.md → Website/docs/application/wake-on-lan.md b/Website/docs/application/wakeonlan.md → Website/docs/application/wake-on-lan.md
diff --git a/Website/docs/application/webconsole.md → Website/docs/application/web-console.md b/Website/docs/application/webconsole.md → Website/docs/application/web-console.md
diff --git a/Website/docs/changelog/2023-11-28-0.md b/Website/docs/changelog/2023-11-28-0.md
@@ -0,0 +1,109 @@
+---
+sidebar_position: 972
+---
+
+# 2023.11.28.0
+
+Version: **2023.11.28.0**<br/>
+Release date: **28.11.2023**
+
+| File                                                                                                                               | Checksum [SHA256]                                                  |
+| ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| [Setup](https://github.com/BornToBeRoot/NETworkManager/releases/download/2023.11.28.0/NETworkManager_2023.11.28.0_Setup.exe)       | `AD9D6E569BFA61F9657A6C823409E4D4B4B67CA4BD0CC5129CCBB0B673D5DF24` |
+| [Portable](https://github.com/BornToBeRoot/NETworkManager/releases/download/2023.11.28.0/NETworkManager_2023.11.28.0_Portable.zip) | `8D15ECE18013C07D806173E051FFA79406A6B5D6D00D1CD48F403C8BDBF7136F` |
+| [Archive](https://github.com/BornToBeRoot/NETworkManager/releases/download/2023.11.28.0/NETworkManager_2023.11.28.0_Archive.zip)   | `39FAC00FBB16D6EFCC3AB571B42AE61C8789E500059F3ED893CE38BFA06CD189` |
+
+**System requirements**
+
+- Windows 10 / Server x64 (1809 or later)
+- [.NET Desktop Runtime 8.0 (LTS) - x64](https://dotnet.microsoft.com/en-us/download/dotnet/8.0/runtime)
+
+## Breaking Changes
+
+- Migrated from .NET 6.0 (LTS) to .NET 8.0 (LTS).
+  Upgrade your [.NET Desktop Runtime to version 8.0 (LTS) - x64](https://dotnet.microsoft.com/en-us/download/dotnet/8.0/runtime) before you install this version. [#2560](https://github.com/BornToBeRoot/NETworkManager/pull/2560)
+- Settings will be reset to default values due to refactoring [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+- Profiles and settings migration (indroduced in `2023.3.7.0`) from `%AppData%\NETworkManager` to `%UserProfile%\Documents\NETworkManager` removed. If you use a version before `2023.3.7.0` you have to install and start version `2023.6.27.1` before you install this version. [#2380](https://github.com/BornToBeRoot/NETworkManager/pull/2380)
+- Remove profile migration script to migrate from `2021.11.30.0` and before to a later version [#2388](https://github.com/BornToBeRoot/NETworkManager/pull/2388)
+
+## What's new?
+
+- Dashboard
+  - Check IP geolocation added [#2392](https://github.com/BornToBeRoot/NETworkManager/pull/2392)
+  - Check DNS resolver added [#2392](https://github.com/BornToBeRoot/NETworkManager/pull/2392)
+- Traceroute
+  - Check IP geolocation for each public IP address added. Feature can be enabled/disabled in settings [#2477](https://github.com/BornToBeRoot/NETworkManager/pull/2477)
+- IP Geolocation added [#2522](https://github.com/BornToBeRoot/NETworkManager/pull/2522) (See [documentation](https://borntoberoot.net/NETworkManager/Documentation/Application/IPGeolocation) for more details)
+
+## Experimental features
+
+- Run command (HotKey: Ctrl+Shift+P) added. This feature allows you to open a command field to switch between applications and pass parameters to them.
+
+{: .note}
+Experimental features can be enabled in the settings under [`Settings > Update`](https://borntoberoot.net/NETworkManager/Documentation/Settings/Update#experimental-features).
+
+## Improvements
+
+- WiFi
+  - MAC address renamed to BSSID [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+  - Values of a WiFi network can now be copied to clipboard via right click context menu [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+- IP Scanner
+  - Row can now be expanded / collapsed via button on the left side. Row is no longer expanded when selecting a row [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+  - Timestamp added to view and export (export format has changed for `csv`, `json` and `xml`) [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+  - Show status message if no reachable host was found [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+- Port Scanner
+  - Show status message if no open port was found [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+- SNMP
+  - Error handling improved and SNMP v3 error codes (Auth failed, etc.) added [#2547](https://github.com/BornToBeRoot/NETworkManager/pull/2547)
+- Lookup - Ports
+  - Search by port number and protocol (e.g. `22/tcp` or `161-162/udp`) added [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+- Profiles
+  - Add unlock button to profile views [#2538](https://github.com/BornToBeRoot/NETworkManager/pull/2538)
+
+## Bugfixes
+
+- Dashboard
+  - IPv6 API call fixed [#2522](https://github.com/BornToBeRoot/NETworkManager/pull/2522)
+- Network Interface
+  - Add missing scrollviewer in configure tab [#2410](https://github.com/BornToBeRoot/NETworkManager/pull/2410)
+- WiFi
+  - Fix an issue where the UI was broken if a WiFi adapter was found that has no assiciated network interface (e.g. if the WiFi adapter is associated with a network bridge). The WiFi adapter is now ignored [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+- Port Scanner
+  - Port profiles can now be sorted in the settings [#2522](https://github.com/BornToBeRoot/NETworkManager/pull/2522)
+- Traceroute
+  - Copy time to clipboard for non reachable hops fixed [#2477](https://github.com/BornToBeRoot/NETworkManager/pull/2477)
+  - Export to Json fixed (if ip address of a hop cannot be resolved) [#2477](https://github.com/BornToBeRoot/NETworkManager/pull/2477)
+- Ping
+  - Copy & Export time fixed (format is now `yyyy-MM-dd HH:mm:ss.fff`) [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+- DNS Lookup
+  - Fix a bug where the suffix is not appended [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+  - Server can now be sorted in the settings [#2522](https://github.com/BornToBeRoot/NETworkManager/pull/2522)
+- AWS Session Manager
+  - Some history settings may not be saved [#2522](https://github.com/BornToBeRoot/NETworkManager/pull/2522)
+  - Profiles can now be sorted in the settings [#2522](https://github.com/BornToBeRoot/NETworkManager/pull/2522)
+- SNMP
+  - Allow `.` as first character in OID (e.g. `1.3.6.1.2.1.1.1.0`) [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+  - SNMP profiles can now be sorted in the settings [#2522](https://github.com/BornToBeRoot/NETworkManager/pull/2522)
+- SNTP Lookup
+  - Copy & Export time fixed (format is now `yyyy-MM-dd HH:mm:ss.fff`) [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+  - Server can now be sorted in the settings [#2522](https://github.com/BornToBeRoot/NETworkManager/pull/2522)
+- Whois
+  - Allow domains with `.` at the end / improved domain validation [#2502](https://github.com/BornToBeRoot/NETworkManager/pull/2502)
+- Lookup - OUI
+  - Don't show duplicate entries [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+- Lookup - Ports
+  - Don't show duplicate entries [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+- Profiles
+  - Prevent the application from crashing if a profile file cannot be loaded (profile management is then blocked) [#2464](https://github.com/BornToBeRoot/NETworkManager/pull/2464)
+  - Application name not translated [#2502](https://github.com/BornToBeRoot/NETworkManager/pull/2502)
+- Settings
+  - Application name not translated [#2502](https://github.com/BornToBeRoot/NETworkManager/pull/2502)
+- Allow hostnames and domains with `.` at the end / improved validation for several tools [#2502](https://github.com/BornToBeRoot/NETworkManager/pull/2502)
+- Fix some focus issues when the enter key is pressed [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+- PowerShell window is hidden again (e.g. configure network interface, add/remove arp entry, etc.) [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483)
+
+## Cleanup, Refactoring & Dependencies
+
+- Code cleanup & Refactoring [#2388](https://github.com/BornToBeRoot/NETworkManager/pull/2388) [#2392](https://github.com/BornToBeRoot/NETworkManager/pull/2392) [#2477](https://github.com/BornToBeRoot/NETworkManager/pull/2477) [#2483](https://github.com/BornToBeRoot/NETworkManager/pull/2483) [#2502](https://github.com/BornToBeRoot/NETworkManager/pull/2502) [#2522](https://github.com/BornToBeRoot/NETworkManager/pull/2522)
+- Language files updated [#transifex](https://github.com/BornToBeRoot/NETworkManager/pulls?q=author%3Aapp%2Ftransifex-integration)
+- Dependencies updated [#dependencies](https://github.com/BornToBeRoot/NETworkManager/pulls?q=author%3Aapp%2Fdependabot)
diff --git a/Website/docs/changelog/2023-12-30-0.md b/Website/docs/changelog/2023-12-30-0.md
diff --git a/Website/docs/changelog/_category_.json b/Website/docs/changelog/_category_.json
@@ -3,6 +3,6 @@
   "position": 3,
   "link": {
     "type": "generated-index",
-    "description": "NETworManager Changelog"
+    "description": "Changelog of all versions"
   }
 }