Merge pull request #1098 from Arnei/readme-unify-configuraiton

Combine "Configuration" sections in ReadMe
opencast · Jul 12, 2023 · dab605a · dab605a
2 parents f79b446 + c7bc17b
commit dab605a
Showing 1 changed file with 38 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -40,7 +40,43 @@ To make the editor work in a sub-path, use:
 Configuration
 -------------
 
-The editor can be configured through the `editor-settings.toml` settings file. It can either be provided in the public folder when running locally or can be found under `etc/opencast/ui-config/mh_default_org/editor` when deployed in Opencast. More information can be found in the example configuration file.
+
+### Configuration Methods
+
+Most configuration options can be set either as an option in the configuration file or as a URL parameter.
+
+The configuration file is called `editor-settings.toml`. It can either be provided in the public folder when running locally or can be found under `etc/opencast/ui-config/mh_default_org/editor` when deployed in Opencast. More information can be found in the example configuration file.
+
+If a configuration option belongs to a section, URL parameters are a combination of section and option separated by a single dot.
+
+For example, the following option in the configuration file:
+
+```toml
+[trackSelection]
+show = true
+```
+
+…can be specified as URL parameter in the form `trackSelection.show=true`.
+
+If an option can be specified both ways, the URL parameter will always take precedence.
+
+
+### Settings
+
+Options which are usually specified in the configuration file are documented in there as well. Metadata configuration options are only documented in the configuration file.
+
+| Option              | URL | File | Description
+| --------------------|-----|------|------------
+| id                  | ✓   | ✓    | Id of the event that the editor should open by default.
+| mediaPackageId      | ✓   | ✓    | Deprecated. Use `id` instead.
+| opencast.url        | ✗   | ✓    | URL of the opencast server to connect to.
+| opencast.name       | ✗   | ✓    | Opencast user to use. For demo purposes only.
+| opencast.password   | ✗   | ✓    | Password to use for authentication. For demo purposes only.
+| metadata.show       | ✓   | ✓    | Show metadata tab.
+| trackSelection.show | ✓   | ✓    | Show track selection tab.
+| thumbnail.show      | ✓   | ✓    | Show thumbnail tab. Demo only.
+| debug               | ✓   | ✗    | Enable internationalization debugging.
+| lng                 | ✓   | ✗    | Select a specific language. Use language codes like `de` or `en-US`.
 
 
 How to cut a release for Opencast
@@ -66,6 +102,7 @@ How to cut a release for Opencast
       if necessary
     - Verify that the new release runs in Opencast, then create the pull request.
 
+
 Opencast API used by the Editor
 -------------
 
@@ -82,45 +119,6 @@ Translating the Editor
 You can help translating the editor to your language on [crowdin.com/project/opencast-editor](https://crowdin.com/project/opencast-editor). Simply request to join the project on Crowdin and start translating. If you are interested in translating a language which is not a target language right now, please create [a GitHub issue](https://github.com/opencast/opencast-editor/issues) and we will add the language.
 
 
-Configuration
--------------
-
-### Configuration Methods
-
-Most configuration options can be set either as a URL parameter or as an option in the configuration file.
-
-If the option belongs to a section, URL parameters are a combination of section and option separated by a single dot.
-
-For example, the following option in the configuration file:
-
-```toml
-[trackSelection]
-show = true
-```
-
-…can be specified as URL parameter in the form `trackSelection.show=true`.
-
-If an option can be specified both ways, the URL parameter will always take precedence.
-
-
-### Settings
-
-Options which are usually specified in the configuration file are documented in there as well. Metadata configuration options are only documented in the configuration file.
-
-| Option              | URL | File | Description
-| --------------------|-----|------|------------
-| id                  | ✓   | ✓    | Id of the event that the editor should open by default.
-| mediaPackageId      | ✓   | ✓    | Deprecated. Use `id` instead.
-| opencast.url        | ✗   | ✓    | URL of the opencast server to connect to.
-| opencast.name       | ✗   | ✓    | Opencast user to use. For demo purposes only.
-| opencast.password   | ✗   | ✓    | Password to use for authentication. For demo purposes only.
-| metadata.show       | ✓   | ✓    | Show metadata tab.
-| trackSelection.show | ✓   | ✓    | Show track selection tab.
-| thumbnail.show      | ✓   | ✓    | Show thumbnail tab. Demo only.
-| debug               | ✓   | ✗    | Enable internationalization debugging.
-| lng                 | ✓   | ✗    | Select a specific language. Use language codes like `de` or `en-US`.
-
-
 Notes on Waveform Generation
 ----------------------------