You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+42-42Lines changed: 42 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,9 +31,9 @@ We suggest to use a specialized markdown editor such as [obsidian](https://obsid
31
31
32
32
The following tools you need locally to get started:
33
33
34
-
-[poetry](https://python-poetry.org/)
35
-
-[task](https://taskfile.dev/)
36
-
-git, markdown editor
34
+
-[poetry](https://python-poetry.org/)
35
+
-[task](https://taskfile.dev/)
36
+
- git, markdown editor
37
37
38
38
On a few OS distributions (e.g. Arch Linux) the tool/binary is named `go-task`.
39
39
@@ -71,26 +71,26 @@ Have a look at the [mkdocs-material documentation](https://squidfunk.github.io/m
71
71
<details>
72
72
<summary>Extend section</summary>
73
73
74
-
-always create a directory + `index.md`, e.g. `my-topic/index.md` ([Example](https://github.com/eccenca/documentation.eccenca.com/tree/main/docs/automate/cmemc-command-line-interface))
75
-
-add new pages to the `.pages` file to add them in the right order and with correct title to the menu ([Example](https://github.com/eccenca/documentation.eccenca.com/blob/main/docs/automate/cmemc-command-line-interface/.pages))
76
-
-put images side by side to the `index.md` ([Example](https://github.com/eccenca/documentation.eccenca.com/tree/main/docs/release-notes/corporate-memory-22-1))
77
-
-do not use images for icons esp. icons from the application
78
-
-use eccenca icons, e.g. [:eccenca-application-queries:](https://github.com/eccenca/documentation.eccenca.com/blob/main/overrides/.icons/eccenca/application-queries.svg) -> [list](https://github.com/eccenca/documentation.eccenca.com/tree/main/overrides/.icons/eccenca)
79
-
-use theme icons where no eccenca icon is available -> [list](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search)
80
-
-name image files properly (not just `Screenshot.xxx.png`, [Example](https://github.com/eccenca/documentation.eccenca.com/tree/main/docs/release-notes/corporate-memory-22-1))
81
-
-used advanced features where suitable
82
-
-[Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage) (esp. use notes and warnings where needed) -> see Admonition section for more details
83
-
-[Code Blocks](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#usage) (e.g. enable highlightning and add a title)
-do not confuse `shell-session` with `bash` (the first is a terminal output, the latter a script syntax)
89
-
-when using `shell-session`, use `$` as the prompt
90
-
-Links:
91
-
-do not use absolute links for internal documents, e.g. `https://documentation.eccenca.com/latest/...`
92
-
-do not use base-relative links, e.g. `/automate/...`
93
-
-use relative links to `index.md` files
74
+
- always create a directory + `index.md`, e.g. `my-topic/index.md` ([Example](https://github.com/eccenca/documentation.eccenca.com/tree/main/docs/automate/cmemc-command-line-interface))
75
+
- add new pages to the `.pages` file to add them in the right order and with correct title to the menu ([Example](https://github.com/eccenca/documentation.eccenca.com/blob/main/docs/automate/cmemc-command-line-interface/.pages))
76
+
- put images side by side to the `index.md` ([Example](https://github.com/eccenca/documentation.eccenca.com/tree/main/docs/release-notes/corporate-memory-22-1))
77
+
- do not use images for icons esp. icons from the application
78
+
- use eccenca icons, e.g. [:eccenca-application-queries:](https://github.com/eccenca/documentation.eccenca.com/blob/main/overrides/.icons/eccenca/application-queries.svg) -> [list](https://github.com/eccenca/documentation.eccenca.com/tree/main/overrides/.icons/eccenca)
79
+
- use theme icons where no eccenca icon is available -> [list](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search)
80
+
- name image files properly (not just `Screenshot.xxx.png`, [Example](https://github.com/eccenca/documentation.eccenca.com/tree/main/docs/release-notes/corporate-memory-22-1))
81
+
- used advanced features where suitable
82
+
-[Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage) (esp. use notes and warnings where needed) -> see Admonition section for more details
83
+
-[Code Blocks](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#usage) (e.g. enable highlightning and add a title)
- do not use line numbers except you refer to it in the text
87
+
- use correct syntax highlightning (often used: `shell-session`, `bash`, `sparql`, `turtle`, `json`) -> [list of syntax IDs](https://pygments.org/docs/lexers/)
88
+
- do not confuse `shell-session` with `bash` (the first is a terminal output, the latter a script syntax)
89
+
- when using `shell-session`, use `$` as the prompt
90
+
- Links:
91
+
- do not use absolute links for internal documents, e.g. `https://documentation.eccenca.com/latest/...`
92
+
- do not use base-relative links, e.g. `/automate/...`
93
+
- use relative links to `index.md` files
94
94
95
95
</details>
96
96
@@ -104,13 +104,13 @@ On this page is search function for icons available as well.
104
104
<details>
105
105
<summary>Extend section</summary>
106
106
107
-
|Admonition Name|Used For |Example|
108
-
|---------------|---------|-------|
109
-
|Info |Information in documentation provides details about a topic or process that the reader needs to know. It is usually essential and relevant to the main subject of the document.|Statement annotations provide a way to express knowledge about statements. This group is dedicated to properties that configure the Statement Annotation feature|
110
-
|Note |A note provides additional details that may or may not be directly related to the main topic. It could be an explanation, clarification, or an aside that the writer thinks would be helpful for the reader to know.|The graph selection drop-down might or might not be visible depending the existence of an (optional) EasyNav Module configuration. In case no specific module configuration exists or non has not has been set for the current workspace the graph selection will be shown. A EasyNav Module configuration pre-configures a graph. Thus, the dropdown will not be shown if such has been configured for the current workspace.|
111
-
|Abstract|An abstract is a brief summary that provides an overview of the main points or contents of a document. It typically appears at the beginning of a document and is intended to give the reader an idea of what to expect from the document.|This tutorial explores the benefits of using cloud computing in enterprise organizations. It discusses the advantages of cloud computing over traditional on-premises infrastructure, and provides guidance for migrating to the cloud.|
112
-
|Warning|It is used to convey the seriousness of the risk and the importance of taking necessary precautions to avoid harm.|If the remote file resource is used in more than one dataset, the other datasets are also affected by this command.|
113
-
|Tip|A tip is a type of admonition in documentation that provides a helpful suggestion or best practice related to the content of the document. It is typically used to guide the reader towards a more efficient or effective way of using a product or service, or to provide additional insights or recommendations.|We have the suggestion option as well; click on the +icon and select the suggestion mapping.|
107
+
|Admonition Name|Used For |Example|
108
+
|---------------|--------|-------|
109
+
|Info |Information in documentation provides details about a topic or process that the reader needs to know. It is usually essential and relevant to the main subject of the document.|Statement annotations provide a way to express knowledge about statements. This group is dedicated to properties that configure the Statement Annotation feature|
110
+
|Note |A note provides additional details that may or may not be directly related to the main topic. It could be an explanation, clarification, or an aside that the writer thinks would be helpful for the reader to know.|The graph selection drop-down might or might not be visible depending the existence of an (optional) EasyNav Module configuration. In case no specific module configuration exists or non has not has been set for the current workspace the graph selection will be shown. A EasyNav Module configuration pre-configures a graph. Thus, the dropdown will not be shown if such has been configured for the current workspace.|
111
+
|Abstract|An abstract is a brief summary that provides an overview of the main points or contents of a document. It typically appears at the beginning of a document and is intended to give the reader an idea of what to expect from the document.|This tutorial explores the benefits of using cloud computing in enterprise organizations. It discusses the advantages of cloud computing over traditional on-premises infrastructure, and provides guidance for migrating to the cloud.|
112
+
|Warning|It is used to convey the seriousness of the risk and the importance of taking necessary precautions to avoid harm.|If the remote file resource is used in more than one dataset, the other datasets are also affected by this command.|
113
+
|Tip|A tip is a type of admonition in documentation that provides a helpful suggestion or best practice related to the content of the document. It is typically used to guide the reader towards a more efficient or effective way of using a product or service, or to provide additional insights or recommendations.|We have the suggestion option as well; click on the +icon and select the suggestion mapping.|
114
114
|Success|Success admonitions are a type of documentation element used to highlight successful outcomes or positive results associated with a particular task, process, or feature|Graph is created successfully.|
115
115
|Bug|A bug admonition include a description of the bug or issue, as well as steps that the user can take to avoid or work around the problem. It may also include information about when the bug will be fixed or patched, if applicable.|Users may experience issues with the file saving feature when running this software on Windows 10. To avoid data loss or corruption, be sure to save your work frequently and consider using an external backup device. Our development team is working to resolve this issue in the next software update.|
116
116
|Example|The example admonition is typically used in instructional or educational documents to clarify complex concepts or demonstrate how to perform a specific task.|To create a new email account, click on the "Sign Up" button on the homepage and enter your name, email address, and desired password. Be sure to choose a strong password with a mix of uppercase and lowercase letters, numbers, and special characters. Once you have entered your information, click "Create Account" to complete the process.|
@@ -123,27 +123,27 @@ On this page is search function for icons available as well.
123
123
<details>
124
124
<summary>Extend section</summary>
125
125
126
-
-do not use a cluttered desktop
127
-
-do not show other esp. personal project artifacts then relevant for the tutorial / feature to show
128
-
-select cropping area carefully (omit backgrounds, lines on the edges, etc.)
129
-
-use the same or a similar area for similar screens
130
-
-all relevant elements should be clearly visible and not be truncated
131
-
-irrelevant elements / details should be omitted completely and not be half visible
132
-
-crop scrollbars (they can make edges look unclean, especially if a scrollbar is directly on an edge)
133
-
-keep an equal distance of all visible elements to the edges of the screenshot
126
+
- do not use a cluttered desktop
127
+
- do not show other esp. personal project artifacts then relevant for the tutorial / feature to show
128
+
- select cropping area carefully (omit backgrounds, lines on the edges, etc.)
129
+
- use the same or a similar area for similar screens
130
+
- all relevant elements should be clearly visible and not be truncated
131
+
- irrelevant elements / details should be omitted completely and not be half visible
132
+
- crop scrollbars (they can make edges look unclean, especially if a scrollbar is directly on an edge)
133
+
- keep an equal distance of all visible elements to the edges of the screenshot
134
134
135
135
</details>
136
136
137
137
## Generated Content
138
138
139
139
<details>
140
140
<summary>The following files are generated from other sources and should not be changed:</summary>
-Shapes and Datatypes: [docs/explore-and-author/graph-exploration/building-a-customized-user-interface/node-shapes|property-shapes|datatype-reference](https://github.com/eccenca/documentation.eccenca.com/tree/main/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/node-shapes)
146
+
- Shapes and Datatypes: [docs/explore-and-author/graph-exploration/building-a-customized-user-interface/node-shapes|property-shapes|datatype-reference](https://github.com/eccenca/documentation.eccenca.com/tree/main/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/node-shapes)
147
147
- to update, start `task update:shape-reference`
148
148
149
149
Where applicable, we added the following disclaimer: `<!-- This file was generated - DO NOT CHANGE IT MANUALLY -->`
If you consider to contribute to this project, please have a look on [CONTRIBUTING.md](https://github.com/eccenca/documentation.eccenca.com/blob/main/CONTRIBUTING.md)
13
13
@@ -27,4 +27,3 @@ This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 Inter
Copy file name to clipboardExpand all lines: docs/automate/cmemc-command-line-interface/command-reference/admin/acl/index.md
+7-43Lines changed: 7 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,22 +13,16 @@ List, create, delete and modify and review access conditions.
13
13
14
14
With this command group, you can manage and inspect access conditions in eccenca Corporate Memory. Access conditions are identified by a URL. They grant access to knowledge graphs or actions to user or groups.
15
15
16
-
17
16
## admin acl list
18
17
19
18
List access conditions.
20
19
21
20
```shell-session title="Usage"
22
-
$ cmemc admin acl list [OPTIONS]
21
+
cmemc admin acl list [OPTIONS]
23
22
```
24
23
25
-
26
-
27
-
28
24
This command retrieves and lists all access conditions, which are manageable by the current account.
29
25
30
-
31
-
32
26
??? info "Options"
33
27
```text
34
28
@@ -42,18 +36,12 @@ This command retrieves and lists all access conditions, which are manageable by
With this command, new access conditions can be created.
75
60
76
61
An access condition captures information about WHO gets access to WHAT. In order to specify WHO gets access, use the ``--user`` and / or ``--group`` options. In order to specify WHAT an account get access to, use the ``--read-graph``, ``--write-graph`` and ``--action`` options.`
@@ -82,14 +67,10 @@ A special case are dynamic access conditions, based on a SPARQL query: Here you
82
67
!!! note
83
68
Queries for dynamic access conditions are copied into the ACL, so changing the query in the query catalog does not change it in the access condition.
This command deletes existing access conditions from the account.
190
163
191
164
!!! note
192
165
Access conditions can be listed by using the `cmemc admin acs list` command.
193
166
194
-
195
-
196
-
197
167
??? info "Options"
198
168
```text
199
169
@@ -206,22 +176,16 @@ This command deletes existing access conditions from the account.
206
176
Review grants for a given account.
207
177
208
178
```shell-session title="Usage"
209
-
$ cmemc admin acl review [OPTIONS] USER
179
+
cmemc admin acl review [OPTIONS] USER
210
180
```
211
181
212
-
213
-
214
-
215
182
This command has two working modes: (1) You can review the access conditions of an actual account, (2) You can review the access conditions of an imaginary account with a set of freely added groups (what-if-scenario).
216
183
217
184
The output of the command is a list of grants the account has based on your input and all access conditions loaded in the store. In addition to that, some metadata of the account is shown.
218
185
219
-
220
-
221
186
??? info "Options"
222
187
```text
223
188
224
189
--raw Outputs raw JSON.
225
190
--group TEXT Add groups to the review request (what-if-scenario).
0 commit comments