From 40394a7dd44599219b7fe5c03a7381e1af2ad55c Mon Sep 17 00:00:00 2001 From: Gerold 'Geri' Broser Date: Mon, 7 Aug 2023 23:55:41 +0200 Subject: [PATCH] GH-1881 Improve dashboard guide * dashboard.md: adds descriptive links to TLA (three-letter abbreviation :) descriptions; fixes typos; beautifies language * dashboard.md: corrects typo * Corrects wording in dashboard.md Co-authored-by: Joshua Sing * dashboard.md: corrects link to proper CDN --------- Co-authored-by: Joshua Sing --- .../data/guides/features/dashboard.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/reposilite-site/data/guides/features/dashboard.md b/reposilite-site/data/guides/features/dashboard.md index ff9dcbba2..7eaef23f2 100644 --- a/reposilite-site/data/guides/features/dashboard.md +++ b/reposilite-site/data/guides/features/dashboard.md @@ -3,36 +3,33 @@ id: dashboard title: Dashboard --- -Reposilite exposes frontend that is mounted to `/#/` as SPA application in Vue 3. -You can disable frontend in [shared configuration](/guide/settings#shared-configuration) -if you just want to disable an easy way to query your repository or to provide custom frontend implementation using [static files](/guide/static-files). +Reposilite exposes a frontend that is mounted to `/#/` as [SPA _(single-page application)_](https://en.wikipedia.org/wiki/Single-page_application) in [Vue 3](https://vuejs.org/). You can disable the frontend in [shared configuration](/guide/settings#shared-configuration) if you want to disable an easy way to query your repository or to provide a custom frontend implementation using [static files](/guide/static-files). #### Browser -Browser displays content of currently selected directory, respectively to provided authentication credentials. For not logged user it lists only public files, for authenticated one it also displays files that user has access to. +Browser displays the content of the currently selected directory in respect to the provided authentication credentials. For users not logged in it lists only public files, for authenticated users it also displays files that the user has access to. ![Dashboard Browser Preview](/images/guides/dashboard-browser-preview.png) -You can control the way Reposilite displays directory content by opening adjustments view through the icon in right top corner: +You can control how Reposilite displays directory content by opening the adjustments view via the icon in the top-right corner: ![Browser Adjustments](/images/guides/dashboard-browser-adjustments.png) #### Console -CLI *(command-line interface)* displays current Reposilite output and allows to perform available [commands](/guide/standalone#interactive-cli). -Only access tokens with management permission can access this view. +CLI _(command-line interface)_ displays the current Reposilite output and allows to perform available [commands](/guide/standalone#interactive-cli). Only access tokens with management permission can access this view. ![CLI Preview](/images/guides/dashboard-console.png) -You can also filter those messages using filters, but keep in mind it searches only though the currently cached log entries, not the whole history. +You can also filter those messages using filters, but keep in mind that it searches only through the currently cached log entries, not the whole history. #### Shared configuration Shared configuration has been already mentioned in: * [Guide / Setup :: Shared configuration](/guide/settings#shared-configuration) -Currently, configuration is provided in CDN format: +Currently, configuration is provided in [CDN _(Configuration Data Notation)_](https://github.com/dzikoysk/cdn) format: ![Dashboard / Configuration](/images/guides/web-interface-configuration.png) -You can modify it and reload changes, most of the properties support hot-reloading, +You can modify it and reload changes. Most of the properties support hot-reloading, so you should see changes immediately _(visual updates after reloading the page)_.