Add admin UI documentation.

knadh · Jun 27, 2022 · f2093b9 · f2093b9
1 parent 0a71eaa
commit f2093b9
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 1 deletion.
diff --git a/cmd/dictpress/init.go b/cmd/dictpress/init.go
@@ -47,7 +47,7 @@ func initDB(host string, port int, user, pwd, dbName string) *sqlx.DB {
 	db, err := sqlx.Connect("postgres",
 		fmt.Sprintf("host=%s port=%d user=%s password=%s dbname=%s sslmode=disable", host, port, user, pwd, dbName))
 	if err != nil {
-		lo.Fatalf("error intiializing DB: %v", err)
+		lo.Fatalf("error initializing DB: %v", err)
 	}
 
 	return db

diff --git a/docs/documentation/docs/admin.md b/docs/documentation/docs/admin.md
@@ -0,0 +1 @@
+The admin UI is accessible at `http://localhost:9000/admin`. Replace the hostname and port with your installation.
diff --git a/docs/documentation/docs/installation.md b/docs/documentation/docs/installation.md
@@ -8,6 +8,8 @@ dictpress requires Postgres ⩾ v10.
 - `./dictpress --install` to install the tables in the Postgres DB.
 - Run `./dictpress` and visit `http://localhost:9000/admin`.
 
+See [Importing data](../import) to populate the dictionary database from CSVs.
+
 
 ## Compiling from source
 

diff --git a/docs/documentation/mkdocs.yml b/docs/documentation/mkdocs.yml
@@ -39,6 +39,7 @@ nav:
   - "Data structure": data-structure.md
   - "Templates": templates.md
   - "Importing data": import.md
+  - "Admin UI": admin.md
   - "Public APIs":
     - "Config": api/config.md
     - "Search": api/search.md