ge-aerospace/shopdb-flask
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Stop the README offering a feature this image cannot provide

Browse Source 
Two claims did not survive the lean cut.

The plugin list and the overview both advertised notifications as carrying a
"recognition feed". Recognition, along with training and recertification, splits
one notification into a card per employee and renders an employee photo - all of
which needs the employees plugin, which this image does not bundle, so those
three types are no longer seeded here. A site reading the README would have gone
looking for a feature that is deliberately absent. The plugin line now says
which types need employees and why.

"Fast path (Docker)" also implied a slower path exists. On this branch Docker is
the only path: there is no installer here, and the Distribution section above it
already says so. Renamed to "Standing up a site".

The rest of the README was already right for what main is - it lists the twelve
bundled plugins, explains that applications is core rather than a plugin, and
describes the three compose files without mentioning the Windows installer that
lives on the site line.
This commit is contained in:
cproudlock
2026-09-19 12:20:47 -04:00
parent bf6b353b52
commit 70f10c6fa0
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -14,7 +14,7 @@ ShopDB tracks and manages:
- **Backups** - Per-asset configuration backups with revision history and diffs - **Backups** - Per-asset configuration backups with revision history and diffs
- **Warranties** - Coverage records with vendor warranty lookups - **Warranties** - Coverage records with vendor warranty lookups
- **Knowledge Base and Guides** - Reference articles and step-by-step procedures with working checklists - **Knowledge Base and Guides** - Reference articles and step-by-step procedures with working checklists
- **Notifications** - Shopfloor announcements and recognition feed - **Notifications** - Shopfloor announcements, planned changes and incident notices
- **Slides** - Lobby display and shopfloor screensaver slideshows - **Slides** - Lobby display and shopfloor screensaver slideshows
## Tech Stack ## Tech Stack
@@ -114,7 +114,7 @@ this checkout, `docker-compose.pull.yml` runs an image published to a
registry, and `docker-compose.airgap.yml` runs an image loaded from a tarball registry, and `docker-compose.airgap.yml` runs an image loaded from a tarball
at a site with no internet. at a site with no internet.
### Fast path (Docker) ### Standing up a site
The Docker image builds the Vue frontend and serves it from the API container, The Docker image builds the Vue frontend and serves it from the API container,
so a container deploy needs no separate Node build step. so a container deploy needs no separate Node build step.
@@ -246,7 +246,7 @@ the PROJECT-MAP page in the project wiki, which is generated:
- **knowledgebase** - Documentation and troubleshooting articles - **knowledgebase** - Documentation and troubleshooting articles
- **machines** - CNC, CMM, and other shop-floor machines - **machines** - CNC, CMM, and other shop-floor machines
- **network** - Network devices and subnets - **network** - Network devices and subnets
- **notifications** - Shopfloor notifications and recognition feed - **notifications** - Shopfloor notifications. The employee-facing types (recognition, training, recertification) need the employees plugin, which this image does not bundle
- **printers** - Extended printer management with Zabbix integration - **printers** - Extended printer management with Zabbix integration
- **slides** - Lobby display and shopfloor screensaver slideshows - **slides** - Lobby display and shopfloor screensaver slideshows
- **tools** - Tech Tools: barcode/QR label generation and one-view secure send - **tools** - Tech Tools: barcode/QR label generation and one-view secure send