Skip to content

Commit 6f95faa

Browse files
committed
normalize (--fix) all markdown files according to linter configuration
1 parent d84b6d2 commit 6f95faa

File tree

515 files changed

+4388
-9201
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

515 files changed

+4388
-9201
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ We suggest to use a specialized markdown editor such as [obsidian](https://obsid
3131

3232
The following tools you need locally to get started:
3333

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
3737

3838
On a few OS distributions (e.g. Arch Linux) the tool/binary is named `go-task`.
3939

@@ -71,26 +71,26 @@ Have a look at the [mkdocs-material documentation](https://squidfunk.github.io/m
7171
<details>
7272
<summary>Extend section</summary>
7373

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)
84-
- [Content Tabs](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#usage) (to structure complex pages)
85-
- code blocks:
86-
- 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
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)
84+
- [Content Tabs](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#usage) (to structure complex pages)
85+
- code blocks:
86+
- 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
9494

9595
</details>
9696

@@ -104,13 +104,13 @@ On this page is search function for icons available as well.
104104
<details>
105105
<summary>Extend section</summary>
106106

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. |
114114
|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.|
115115
|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.|
116116
|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.
123123
<details>
124124
<summary>Extend section</summary>
125125

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
134134

135135
</details>
136136

137137
## Generated Content
138138

139139
<details>
140140
<summary>The following files are generated from other sources and should not be changed:</summary>
141-
142-
- cmemc Command Reference: [docs/automate/cmemc-command-line-interface/command-reference](https://github.com/eccenca/documentation.eccenca.com/tree/main/docs/automate/cmemc-command-line-interface/command-reference)
141+
142+
- cmemc Command Reference: [docs/automate/cmemc-command-line-interface/command-reference](https://github.com/eccenca/documentation.eccenca.com/tree/main/docs/automate/cmemc-command-line-interface/command-reference)
143143
- to update, start `task update:cmemc`
144-
- Coporate Memory Application Icons: [overrides/.icons/eccenca](https://github.com/eccenca/documentation.eccenca.com/tree/main/overrides/.icons/eccenca)
144+
- Coporate Memory Application Icons: [overrides/.icons/eccenca](https://github.com/eccenca/documentation.eccenca.com/tree/main/overrides/.icons/eccenca)
145145
- to update, start `task update:icons`
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)
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)
147147
- to update, start `task update:shape-reference`
148148

149149
Where applicable, we added the following disclaimer: `<!-- This file was generated - DO NOT CHANGE IT MANUALLY -->`

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
Shared repository of the eccenca Corporate Memory documentation.
66

7-
| Branch | Deployment |
8-
| :--- | :--- |
9-
| `main` | [https://dev.documentation.eccenca.com](https://dev.documentation.eccenca.com) |
10-
| `published` | [https://documentation.eccenca.com](https://documentation.eccenca.com) |
7+
| Branch | Deployment |
8+
| :----- | :--------- |
9+
| `main` | [https://dev.documentation.eccenca.com](https://dev.documentation.eccenca.com) |
10+
| `published` | [https://documentation.eccenca.com](https://documentation.eccenca.com) |
1111

1212
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)
1313

@@ -27,4 +27,3 @@ This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 Inter
2727
[mkdocs-shield]: https://img.shields.io/badge/Made%20with-mkdocs-brightgreen
2828
[mkdocs]: https://www.mkdocs.org/
2929
[markdown-shield]: https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg
30-

docs/automate/cmemc-command-line-interface/command-reference/admin/acl/index.md

Lines changed: 7 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,16 @@ List, create, delete and modify and review access conditions.
1313

1414
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.
1515

16-
1716
## admin acl list
1817

1918
List access conditions.
2019

2120
```shell-session title="Usage"
22-
$ cmemc admin acl list [OPTIONS]
21+
cmemc admin acl list [OPTIONS]
2322
```
2423

25-
26-
27-
2824
This command retrieves and lists all access conditions, which are manageable by the current account.
2925

30-
31-
3226
??? info "Options"
3327
```text
3428

@@ -42,18 +36,12 @@ This command retrieves and lists all access conditions, which are manageable by
4236
Inspect an access condition.
4337

4438
```shell-session title="Usage"
45-
$ cmemc admin acl inspect [OPTIONS] ACCESS_CONDITION_ID
39+
cmemc admin acl inspect [OPTIONS] ACCESS_CONDITION_ID
4640
```
4741

48-
49-
50-
5142
!!! note
5243
access conditions can be listed by using the `acl list` command.
5344

54-
55-
56-
5745
??? info "Options"
5846
```text
5947

@@ -65,12 +53,9 @@ $ cmemc admin acl inspect [OPTIONS] ACCESS_CONDITION_ID
6553
Create an access condition.
6654

6755
```shell-session title="Usage"
68-
$ cmemc admin acl create [OPTIONS]
56+
cmemc admin acl create [OPTIONS]
6957
```
7058

71-
72-
73-
7459
With this command, new access conditions can be created.
7560

7661
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
8267
!!! note
8368
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.
8469

85-
8670
```shell-session title="Example"
87-
$ cmemc admin acl create --group local-users --write-graph https://example.org/
71+
cmemc admin acl create --group local-users --write-graph https://example.org/
8872
```
8973

90-
91-
92-
9374
??? info "Options"
9475
```text
9576

@@ -132,16 +113,11 @@ $ cmemc admin acl create --group local-users --write-graph https://example.org/
132113
Update an access condition.
133114

134115
```shell-session title="Usage"
135-
$ cmemc admin acl update [OPTIONS] ACCESS_CONDITION_ID
116+
cmemc admin acl update [OPTIONS] ACCESS_CONDITION_ID
136117
```
137118

138-
139-
140-
141119
Given an access condition URL, you can change specific options to new values.
142120

143-
144-
145121
??? info "Options"
146122
```text
147123

@@ -180,20 +156,14 @@ Given an access condition URL, you can change specific options to new values.
180156
Delete access conditions.
181157

182158
```shell-session title="Usage"
183-
$ cmemc admin acl delete [OPTIONS] [ACCESS_CONDITION_IDS]...
159+
cmemc admin acl delete [OPTIONS] [ACCESS_CONDITION_IDS]...
184160
```
185161

186-
187-
188-
189162
This command deletes existing access conditions from the account.
190163

191164
!!! note
192165
Access conditions can be listed by using the `cmemc admin acs list` command.
193166

194-
195-
196-
197167
??? info "Options"
198168
```text
199169

@@ -206,22 +176,16 @@ This command deletes existing access conditions from the account.
206176
Review grants for a given account.
207177

208178
```shell-session title="Usage"
209-
$ cmemc admin acl review [OPTIONS] USER
179+
cmemc admin acl review [OPTIONS] USER
210180
```
211181

212-
213-
214-
215182
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).
216183

217184
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.
218185

219-
220-
221186
??? info "Options"
222187
```text
223188

224189
--raw Outputs raw JSON.
225190
--group TEXT Add groups to the review request (what-if-scenario).
226191
```
227-

0 commit comments

Comments
 (0)