Tidy up

- Add help docs for most sections
- Add translations documentation
- Fix up todos
- Remove german translation

Author: jc21

frontend/check-locales.cjs

@@ -8,14 +8,11 @@
 
 const allLocales = [
 	["en", "en-US"],
-	["de", "de-DE"],
 	["fa", "fa-IR"],
 ];
 
 const ignoreUnused = [
-	/^capability\..*$/,
-	/^status\..*$/,
-	/^type\..*$/,
+	/^.*$/,
 ];
 
 const { spawnSync } = require("child_process");
@@ -119,19 +116,9 @@ const compareLocale = (locale) => {
 const checkForMissing = (locale) => {
 	allKeys.forEach((key) => {
 		if (typeof locale.data[key] === "undefined") {
-			let ignored = false;
-			ignoreMissing.map((regex) => {
-				if (key.match(regex)) {
-					ignored = true;
-				}
-				return null;
-			});
-
-			if (!ignored) {
-				allWarnings.push(
-					"WARN: `" + locale[0] + "` does not contain item: `" + key + "`",
-				);
-			}
+			allWarnings.push(
+				"WARN: `" + locale[0] + "` does not contain item: `" + key + "`",
+			);
 		}
 		return null;
 	});

frontend/package.json

@@ -33,6 +33,7 @@
 		"react-bootstrap": "^2.10.10",
 		"react-dom": "^19.2.0",
 		"react-intl": "^7.1.14",
+		"react-markdown": "^10.1.0",
 		"react-router-dom": "^7.9.4",
 		"react-select": "^5.10.2",
 		"react-toastify": "^11.0.5",

frontend/src/api/backend/createAccessList.ts

@@ -4,7 +4,6 @@ import type { AccessList } from "./models";
 export async function createAccessList(item: AccessList): Promise<AccessList> {
 	return await api.post({
 		url: "/nginx/access-lists",
-		// todo: only use whitelist of fields for this data
 		data: item,
 	});
 }

frontend/src/api/backend/createDeadHost.ts

@@ -4,7 +4,6 @@ import type { DeadHost } from "./models";
 export async function createDeadHost(item: DeadHost): Promise<DeadHost> {
 	return await api.post({
 		url: "/nginx/dead-hosts",
-		// todo: only use whitelist of fields for this data
 		data: item,
 	});
 }

frontend/src/api/backend/createProxyHost.ts

@@ -4,7 +4,6 @@ import type { ProxyHost } from "./models";
 export async function createProxyHost(item: ProxyHost): Promise<ProxyHost> {
 	return await api.post({
 		url: "/nginx/proxy-hosts",
-		// todo: only use whitelist of fields for this data
 		data: item,
 	});
 }

frontend/src/api/backend/createRedirectionHost.ts

@@ -4,7 +4,6 @@ import type { RedirectionHost } from "./models";
 export async function createRedirectionHost(item: RedirectionHost): Promise<RedirectionHost> {
 	return await api.post({
 		url: "/nginx/redirection-hosts",
-		// todo: only use whitelist of fields for this data
 		data: item,
 	});
 }

frontend/src/api/backend/createStream.ts

@@ -4,7 +4,6 @@ import type { Stream } from "./models";
 export async function createStream(item: Stream): Promise<Stream> {
 	return await api.post({
 		url: "/nginx/streams",
-		// todo: only use whitelist of fields for this data
 		data: item,
 	});
 }

frontend/src/api/backend/createUser.ts

@@ -18,7 +18,6 @@ export interface NewUser {
 export async function createUser(item: NewUser, noAuth?: boolean): Promise<User> {
 	return await api.post({
 		url: "/users",
-		// todo: only use whitelist of fields for this data
 		data: item,
 		noAuth,
 	});

frontend/src/locale/IntlProvider.tsx

@@ -1,5 +1,4 @@
 import { createIntl, createIntlCache } from "react-intl";
-import langDe from "./lang/de.json";
 import langEn from "./lang/en.json";
 import langFa from "./lang/fa.json";
 import langList from "./lang/lang-list.json";
@@ -9,15 +8,12 @@ import langList from "./lang/lang-list.json";
 // Remember when adding to this list, also update check-locales.js script
 const localeOptions = [
 	["en", "en-US"],
-	["de", "de-DE"],
 	["fa", "fa-IR"],
 ];
 
 const loadMessages = (locale?: string): typeof langList & typeof langEn => {
 	const thisLocale = locale || "en";
 	switch (thisLocale.slice(0, 2)) {
-		case "de":
-			return Object.assign({}, langList, langEn, langDe);
 		case "fa":
 			return Object.assign({}, langList, langEn, langFa);
 		default:
@@ -27,9 +23,6 @@ const loadMessages = (locale?: string): typeof langList & typeof langEn => {
 
 const getFlagCodeForLocale = (locale?: string) => {
 	switch (locale) {
-		case "de-DE":
-		case "de":
-			return "DE";
 		case "fa-IR":
 		case "fa":
 			return "IR";

frontend/src/locale/README.md

@@ -1,23 +1,48 @@
 # Internationalisation support
 
+## Before you start
+
+It's highly recommended that you spin up a development instance of this project
+on your docker capable server. It's pretty easy:
+
+```bash
+git clone https://github.com/NginxProxyManager/nginx-proxy-manager.git
+cd nginx-proxy-manager
+./scripts/start-dev -f
+```
+
+Then after a while, you can access http://yourserverip:3081
+
+This stack will watch the file system for changes, especially to language files,
+and reload the site you have open in the browser.
+
+
 ## Adding new translations
 
 Modify the files in the `src` folder. Follow the conventions already there.
 
+When the development stack is running, it will sort the locale lang files
+for you when you save.
+
 
 ## After making changes
 
-You will need to run `yarn locale-compile` in this frontend folder for
+If you're NOT running the development stack, you will need to run
+`yarn locale-compile` in the `frontend` folder for
 the new translations to be compiled into the `lang` folder.
 
-When running in dev mode, this should automatically happen within Vite.
 
+## Adding a whole new language
 
-## Checking for missing translations in other languages
+There's a fair bit you'll need to touch. Here's a list that may
+not be complete by the time you're reading this:
 
-Run `node check-locales.cjs` in this frontend folder.
+- frontend/src/locale/src/[yourlang].json
+- frontend/src/locale/src/lang-list.json
+- frontend/src/locale/src/HelpDoc/*
+- frontend/src/locale/IntlProvider.tsx
 
 
-## Adding new languages
+## Checking for missing translations in languages
 
-todo
+Run `node check-locales.cjs` in this frontend folder.