From 2ae03a6262607ec2c1d195abd683a25fdaafc6d1 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Fri, 21 Apr 2023 17:59:03 +0200
Subject: [PATCH] DOC: Unrelated small changes.
---
README_SETUP.md | 1 +
src/doc/extension/display_of_properties.rst | 10 +++++-----
src/doc/index.rst | 5 +++--
3 files changed, 9 insertions(+), 7 deletions(-)
diff --git a/README_SETUP.md b/README_SETUP.md
index 485835fd..fdd6b9f4 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -22,6 +22,7 @@
-->
# Getting Started with the Web Interface
+
Here, we document how to install and build the CaosDB Web Interface. If you are
only interested in how to use it, please continue [here](tutorials/first_steps.html)
diff --git a/src/doc/extension/display_of_properties.rst b/src/doc/extension/display_of_properties.rst
index 29d254c1..e19b7030 100644
--- a/src/doc/extension/display_of_properties.rst
+++ b/src/doc/extension/display_of_properties.rst
@@ -34,10 +34,10 @@ property, and the names of the roles and/or users from whom it should be hidden.
"roles": ["list", "of", "roles"],
"users": ["list", "of", "users"]
},
- ...
+ // ...
]
},
- ...
+ // ...
}
In the same way but using the ``show`` keyword, properties can be hidden for
@@ -53,10 +53,10 @@ everyone **but** the specified users/roles:
"roles": ["list", "of", "roles"],
"users": ["list", "of", "users"]
},
- ...
+ // ...
]
},
- ...
+ // ...
}
@@ -90,7 +90,7 @@ configured in the same configuration file as above, i.e., in
"RecordTypeName": {
"order": ["ordered", "list", "of", "properties"]
},
- ...
+ // ...
}
This ensures that the properties of all entities with the declared types are
diff --git a/src/doc/index.rst b/src/doc/index.rst
index 24c39434..73277291 100644
--- a/src/doc/index.rst
+++ b/src/doc/index.rst
@@ -12,11 +12,12 @@ Welcome to the documentation of CaosDB's web UI!
Concepts <concepts>
administration/index.rst
Extending the UI <extension>
- API <api/index>
+ ..
+ API <api/index>
This documentation helps you to :doc:`get started<getting_started>`, explains the most important
-:doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials>`.
+:doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials/index>`.
Indices and tables
--
GitLab