Merge branch 'main' of https://github.com/pvarki/Docusaurus-docs

Author: benjamsf

docs/dev/battlelog/README.md

@@ -0,0 +1,34 @@
+# livelogi
+
+## Install
+
+1. Install docker + compose
+2. Rename .env_example --> .env and modify as you like.
+3. Run docker compose build --no-cache
+4. Run docker compose up -d
+5. Navigate to localhost:3000
+
+## Frontend development
+
+The frontend is bundled with [Vite](https://vitejs.dev/).
+
+Once the backend is running (on port 3000), you can navigate to `frontend/`,
+run `npm i` and `npm run dev` to run the Vite development server that has
+hot reload and all that jazz.
+
+## Info
+
+Database is currently preseeded with test data from preseed/preseed.csv
+
+## Migrations
+
+To add new migration, locally run: `./node_modules/.bin/node-pg-migrate create <MIGRATION_NAME>` and modify created file in `/migrations` directory.
+Migrations are run (if needed) when docker container starts. `wait-for-it.sh` will ensure that psql container is up and accepting connections before running migrations.
+
+## JWT testing
+
+Remove comments from "jwt-test-network" for local jwt testing, to allow joining containers from 2 different compose runs to same docker network.
+
+## OpenAPI Specification
+
+https://pvarki.github.io/typescript-liveloki-app/

docs/dev/battlelog/instructions/Livelog.md

@@ -0,0 +1,68 @@
+
+## Usage
+
+### Creating a new event
+
+Livelog is platform to aggregate and enrich data brought from different sources.
+All data in Livelog is handled in "events". Single event can contain following inputs:
+
+
+![[PVARKI-livelogi-ohje.jpg]]
+
+- 1. Header
+	- Header of the event.
+- 2. Source
+	- Where the data is coming from.
+- 3. Date / time
+	- Date and time of the event (this is the time when something happened, not when it was submitted to Livelog).
+- 4. HCOE Domains
+	- Categorization of the event based on Hybrid CoE classification.
+- 5. Link
+	- If the event was something that has permanent link (for example Facebook post/ news article, forum post, etc)
+- 6. Admiralty code -> Reliability / Accuracy
+	- https://en.wikipedia.org/wiki/Admiralty_code
+- 7. Keywords
+	- Tags/keywords to help group and search information.
+	- Drop down menu will show and search existing keywords when user is inputting a new keyword.
+- 8. Location
+	- Geographic location of the event
+	- Includes option to input coordinates and/or free text, if coordinates are unknown.
+	- Location can also be set by using the provided map.
+
+
+
+After inputting the event details, you can add another event by pressing the "Add Another Event" (9) or press "Submit Event" (10) to save already ready events.
+
+
+
+### Searching existing events
+
+
+Search (11) allows user to perform search of the database for existing events. It will also use fuzzy search to filter results real time while user is typing.
+
+Alert Keyword (12) will highlight all events matching the user input.
+
+Search and Alert can be used both together to narrow down results and mark important results more clearly.
+
+Toggle Map icon (13) opens the map displaying all existing events that have coordinates set.
+
+Toggle List icon (14) opens the list listing all events or events matching the user input.
+
+
+### Viewing existing events
+
+
+![[PVARKI-livelogi-ohje-2.jpg]]
+
+Permalink (15) opens the single event view. This link is also shareable and permanent/unique per event, so it remains unchanged and will always lead back to this event.
+
+Map view (16) opens the Open Street Map view pointing to the coordinates, if coordinates were given when creating the event.
+
+### Single event view
+
+
+![[PVARKI-livelogi-ohje-3.jpg]]
+
+Displays all details from the selected event.
+
+Upload media (17) allows user to add images for the event.