From 6a6bde6752e1f4ccfd84237e7b3f6dd6936f719a Mon Sep 17 00:00:00 2001 From: Roland Date: Wed, 31 Jul 2024 11:58:37 -0600 Subject: [PATCH] Adding docs for Tags Directory. --- docs/system/primary-secondary-tertiary.md | 1 + docs/system/special-directories.md | 36 +++++++++++++++-------- 2 files changed, 24 insertions(+), 13 deletions(-) diff --git a/docs/system/primary-secondary-tertiary.md b/docs/system/primary-secondary-tertiary.md index 1566239..35a9df5 100644 --- a/docs/system/primary-secondary-tertiary.md +++ b/docs/system/primary-secondary-tertiary.md @@ -10,3 +10,4 @@ and tertiary options to use your WROLPi may be available. | Map | [React App](../modules/map/index.md) | Map is directly accessible on port `:8084` | None | | Zim | [React App](../modules/zim/index.md) | Kiwix server is directly accessible on port `:8085` | [Kiwix application](../modules/zim/index.md#kiwix-without-wrolpi) | | Help | React App | Help server is directly accessible on port `:8086` | Markdown files are available in `/opt/wrolpi-help/docs` | +| Tags | React App | Browse the Tags Directory: `/media/wrolpi/tags` | Read the config: `/media/wrolpi/config/tags.yaml` | \ No newline at end of file diff --git a/docs/system/special-directories.md b/docs/system/special-directories.md index 19aa5b5..ff1a2f7 100644 --- a/docs/system/special-directories.md +++ b/docs/system/special-directories.md @@ -1,12 +1,13 @@ # Special System Directories -| Path | Purpose | -|-------------------------|----------------------------------------------------------| -| `/media/wrolpi/` | The [Media Directory](#media-directory). | -| `/opt/wrolpi/` | The [source code](#wrolpi-source-directory) of WROLPi. | -| `/media/wrolpi/config/` | The [configuration files](#wrolpi-config) of the WROLPi. | -| `/opt/wrolpi-blobs/` | Contains files necessary to repair a WROLPi. | -| `/opt/wrolpi-help/` | These help files. | +| Path | Purpose | +|-------------------------|--------------------------------------------------------------------------------------| +| `/media/wrolpi/` | The [Media Directory](#media-directory). | +| `/media/wrolpi/config/` | The [configuration files](#wrolpi-config) of the WROLPi. | +| `/media/wrolpi/tags/` | The [Tags Directory](#tags-directory) contains links to files that have been tagged. | +| `/opt/wrolpi-blobs/` | Contains files necessary to repair a WROLPi. | +| `/opt/wrolpi-help/` | These help files. | +| `/opt/wrolpi/` | The [source code](#wrolpi-source-directory) of WROLPi. | ## Media Directory @@ -17,12 +18,6 @@ files that are downloaded by WROLPi will be saved within this directory. The normal media directory is `/media/wrolpi` -## WROLPi Source Directory - -`/opt/wrolpi/` - -This directory contains the source code of the WROLPi API, app, etc. - ## WROLPi Config `/media/wrolpi/config/` @@ -30,6 +25,15 @@ This directory contains the source code of the WROLPi API, app, etc. This directory contains the configuration files of the WROLPi. These files are considered the "source of truth" and their contents will alter the behavior of the WROLPi. +## Tags Directory + +`/media/wrolpi/tags` + +This directory contains links to tagged files. It is automatically managed by WROLPi as you add or remove tags from +files. + +**Warning!** Do not store files in this directory, they will be automatically deleted. + ## WROLPi Blobs `/opt/wrolpi-blobs/` @@ -42,3 +46,9 @@ Postgresql dump of the map database. **It is best to leave this directory as-is `/opt/wrolpi-help/` This help file you are reading is contained in this directory. + +## WROLPi Source Directory + +`/opt/wrolpi/` + +This directory contains the source code of the WROLPi API, app, etc.