Skip to content

Commit

Permalink
Corrections in documentation of root view setting
Browse files Browse the repository at this point in the history
  • Loading branch information
@Flix6x
Flix6x committed Sep 3, 2021
1 parent 1423cff commit 3d83ee2
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions documentation/configuration.rst
View file
Expand Up @@ -93,7 +93,7 @@ Name being used in headings and in the menu bar.

For more fine-grained control, this can also be a list, where it's possible to set the platform name for certain account roles (as a tuple of view name and list of applicable account roles). In this case, the list is searched from left to right, and the first fitting name is used.

For example, ``("MyMDCApp", ["MDC"]), "MyApp"]`` would use the name "MyMDCApp" for users connected to accounts with the account role "MDC" while all others would see the name "/MyApp".
For example, ``("MyMDCApp", ["MDC"]), "MyApp"]`` would use the name "/MyMDCApp" for users connected to accounts with the account role "MDC" while all others would see the name "/MyApp".

This comment has been minimized.

Sign in to view

Copy link
@nhoening

nhoening Sep 3, 2021

Contributor

This is wrong I believe. That setting is just a name, not to be used in URLs, and it won't get a slash.

This comment has been minimized.

Sign in to view

Copy link
@Flix6x

Flix6x Sep 3, 2021

Author Contributor

Then please be consistent. There's a couple places that could use some clarity. What you had before:

  • would use the name "MyMDCApp" ("use" and no slash, this is meant to be used as a name only right?)
  • would see the name "/MyApp" ("see" and slash, this is meant to be used as a name only right?)
  • would show "/mdc-dashboard" ("show" and slash, this is meant to be used as a url only right?)
  • would be routed to "/default-dashboard" ("be routed to" and slash, this is meant to be used as a url only right?)
  • the "/" view will be shown ("will be shown" and slash)

I propose we use the phrase "routed to" for the url setting, and "see the name" for the name setting.

This comment has been minimized.

Sign in to view

Copy link
@nhoening

nhoening Sep 3, 2021

Contributor

Yes, the occurrence of "see the name" and a slash was a copy-paste mistake by me.

I agree with your phrasing convention. Should I look those over?

.. note:: This fine-grained control requires FlexMeasures version 0.6.0

Expand All @@ -107,7 +107,7 @@ Root view (reachable at "/"). For example ``"/dashboard"``.

For more fine-grained control, this can also be a list, where it's possible to set the root view for certain account roles (as a tuple of view name and list of applicable account roles). In this case, the list is searched from left to right, and the first fitting view is shown.

For example, ``[("metering-dashboard", ["MDC", "Prosumer"]), "default-dashboard"]`` would show "/mdc-dashboard" for users connected to accounts with account roles "MDC" or "Prosumer", while all others would be routed to "/default-dashboard".
For example, ``[("metering-dashboard", ["MDC", "Prosumer"]), "default-dashboard"]`` would show "/metering-dashboard" for users connected to accounts with account roles "MDC" or "Prosumer", while all others would be routed to "/default-dashboard".

If this setting is empty or not applicable for the current user, the "/" view will be shown (FlexMeasures' default dashboard or a plugin view which was registered at "/").

Expand Down

0 comments on commit 3d83ee2

Please sign in to comment.