Skip to content

Commit 248a64c

Browse files
committed
Merge remote-tracking branch 'origin/main' into feature/harmonize-various-styles-and-language-CMEM-8037
# Conflicts: # docs/deploy-and-configure/configuration/explore/dataplatform/application-neptune-full.md # docs/develop/index.md # docs/explore-and-author/graph-exploration/building-a-customized-user-interface/index.md
2 parents f118ba6 + 04fcb1a commit 248a64c

153 files changed

Lines changed: 21932 additions & 1711 deletions

File tree

Some content is hidden

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

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ tmp
99
.vscode/
1010
.python-version
1111
dist/
12+
.env

.markdownlint.jsonc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,16 @@
2828
"span",
2929
"summary",
3030
"connection",
31-
"tool"
31+
"tool",
32+
"code"
3233
]
3334
},
3435
"MD035": false,
3536
"MD036": false,
3637
"MD041": false,
3738
"MD045": false,
3839
"MD046": false,
40+
"MD051": false,
3941
"MD059": false,
4042
"MD060": false,
4143
"MD077": false

Taskfile.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
version: '3'
55

6+
dotenv: ['.env']
7+
68
vars:
79
PUBLIC_BRANCH: published
810
CURRENT_VERSION: 26.2
@@ -135,6 +137,39 @@ tasks:
135137
vars:
136138
REFERENCE_DIR: docs/automate/cmemc-command-line-interface/command-reference
137139

140+
update:cmem-client-api:
141+
desc: re-generates the cmem-client Python API reference (needs local cmem-client checkout)
142+
summary: |
143+
Regenerates docs/develop/cmem-client-api/api-reference from the
144+
docstrings of a local cmem-client checkout, via that repository's own
145+
`task docs:export-md` (see etc/export_api_md.py there).
146+
147+
The landing page (docs/develop/cmem-client-api/index.md) and its
148+
.pages file are hand-written and untouched by this task - only the
149+
api-reference/ subtree is wiped and regenerated.
150+
151+
This documents whatever branch/commit is currently checked out in
152+
CMEM_CLIENT_DIR, not necessarily the last release - check out the ref
153+
you want documented before running this.
154+
155+
CMEM_CLIENT_DIR=/path/to/cmem-client task update:cmem-client-api
156+
preconditions:
157+
- sh: '[ -n "{{.CMEM_CLIENT_DIR}}" ]'
158+
msg: |
159+
CMEM_CLIENT_DIR is not set. Run this task with the path to a local
160+
cmem-client checkout, e.g.:
161+
162+
CMEM_CLIENT_DIR=/path/to/cmem-client task update:cmem-client-api
163+
cmds:
164+
- rm -rf {{.REFERENCE_DIR}}/*
165+
- task -d {{.CMEM_CLIENT_DIR}} docs:export-md OUTPUT_DIR={{.ROOT_DIR}}/{{.REFERENCE_DIR}}
166+
- cmd: >
167+
find {{.ROOT_DIR}}/{{.REFERENCE_DIR}} -type f -name '*.md' -print0
168+
| xargs -0 poetry run rumdl --config .markdownlint.jsonc check --fix
169+
ignore_error: true
170+
vars:
171+
REFERENCE_DIR: docs/develop/cmem-client-api/api-reference
172+
138173
update:shape-reference:
139174
desc: re-generates the shape and datatype references (needs local CO)
140175
summary: >
@@ -174,6 +209,9 @@ tasks:
174209
desc: update the task and operator reference pages (needs local CO)
175210
cmds:
176211
- poetry run dec-tool update-di-reference
212+
- >
213+
find ./docs/build/reference -type f -name '*.md' -print0
214+
| xargs -0 poetry run rumdl --config .markdownlint.jsonc check --fix
177215
178216
update:integrations:
179217
desc: update integrations page (needs data/integrations.yml)

data/integrations.yml

Lines changed: 84 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,10 @@ integrations:
100100
- name: Office 365
101101
icon: ":material-microsoft-office:"
102102
content: |
103-
Use the {{p.office365preadsheet}} to read and write to Excel workbooks in Office 365.
103+
Use the {{p.office365preadsheet}} to read and write to Excel workbooks in Office 365, or
104+
[list]({{p.cmem_plugin_office365_List_ref}}),
105+
[download]({{p.cmem_plugin_office365_Download_ref}}) and
106+
[upload]({{p.cmem_plugin_office365_Upload_ref}}) files in Microsoft OneDrive or Sites.
104107
105108
- name: Google Drive
106109
icon: ":material-google-drive:"
@@ -110,7 +113,10 @@ integrations:
110113
- name: SSH
111114
icon: ":material-ssh:"
112115
content: |
113-
Interact with SSH servers to {{p.cmem_plugin_ssh_Download}} or {{p.cmem_plugin_ssh_Execute}}.
116+
Interact with SSH servers: [list]({{p.cmem_plugin_ssh_List_ref}}),
117+
[download]({{p.cmem_plugin_ssh_Download_ref}}) and
118+
[upload]({{p.cmem_plugin_ssh_Upload_ref}}) files, or
119+
[execute commands]({{p.cmem_plugin_ssh_Execute_ref}}) on them.
114120
115121
- name: Kubernetes
116122
icon: ":simple-kubernetes:"
@@ -122,10 +128,11 @@ integrations:
122128
content: |
123129
You can execute a {{p.cmem_plugin_graphql_workflow_graphql_GraphQLPlugin}} and process the result in a workflow.
124130
125-
- name: eMail / SMTP
131+
- name: eMail / SMTP / IMAP
126132
icon: ":material-email-outline:"
127133
content: |
128-
Send plain text or HTML formatted [eMail messages]({{p.SendEMail_ref}}) using an SMTP server.
134+
Send plain text or HTML formatted [eMail messages]({{p.SendEMail_ref}}) using an SMTP server,
135+
or {{p.cmem_plugin_email_GetEmails}} including their attachments from an IMAP mailbox.
129136
130137
- name: Jira
131138
icon: ":simple-jira:"
@@ -136,12 +143,14 @@ integrations:
136143
icon: ":simple-apachekafka:"
137144
content: |
138145
You can [send]({{p.cmem_plugin_kafka_SendMessages_ref}}) and
139-
[receive messages]({{p.cmem_plugin_kafka_ReceiveMessages_ref}}) to and from a Kafka topic.
146+
[receive messages]({{p.cmem_plugin_kafka_ReceiveMessages_ref}}) to and from a Kafka topic,
147+
on a plain broker as well as on a [Confluent Cloud](https://confluent.cloud) cluster.
140148
141149
- name: Nextcloud
142150
icon: ":simple-nextcloud:"
143151
content: |
144-
Use a Nextcloud instance to [download files]({{p.cmem_plugin_nextcloud_Download_ref}}) to process
152+
Use a Nextcloud instance to [list]({{p.cmem_plugin_nextcloud_List_ref}}) and
153+
[download files]({{p.cmem_plugin_nextcloud_Download_ref}}) to process
145154
them or [upload files]({{p.cmem_plugin_nextcloud_Upload_ref}}) you created with Corporate Memory.
146155
147156
- name: Salesforce
@@ -178,6 +187,52 @@ integrations:
178187
Leverage your Knowledge Graphs in Redash using the integrated
179188
[Corporate Memory Redash-Connector](../../consume/consuming-graphs-with-redash/index.md).
180189
190+
- name: Apify
191+
icon: ":other-apify:"
192+
content: |
193+
Use the {{p.cmem_plugin_apify_RunActor}} task to run web scrapers and other
194+
[Apify](https://apify.com) actors, and process the resulting dataset in your workflow.
195+
196+
- name: CKAN
197+
icon: ":other-ckan:"
198+
content: |
199+
[Download the files]({{p.cmem_plugin_ckan_Download_ref}}) of a dataset from a
200+
[CKAN](https://ckan.org) service, or
201+
[publish files]({{p.cmem_plugin_ckan_Upload_ref}}) as the resources of a CKAN dataset.
202+
203+
- name: GitHub
204+
icon: ":simple-github:"
205+
content: |
206+
[List]({{p.cmem_plugin_git_List_ref}}) and
207+
[download]({{p.cmem_plugin_git_Download_ref}}) files from a GitHub repository, or
208+
[commit]({{p.cmem_plugin_git_Upload_ref}}) the results of a workflow back into it.
209+
210+
- name: GitLab
211+
icon: ":simple-gitlab:"
212+
content: |
213+
[List]({{p.cmem_plugin_git_List_ref}}) and
214+
[download]({{p.cmem_plugin_git_Download_ref}}) files from a GitLab repository, or
215+
[commit]({{p.cmem_plugin_git_Upload_ref}}) the results of a workflow back into it.
216+
217+
- name: eccenca Marketplace
218+
icon: ":eccenca-module-marketplace:"
219+
content: |
220+
Manage [Marketplace Packages](../../develop/packages/index.md) in workflows:
221+
[build package archives]({{p.cmem_plugin_packages_BuildPackages_ref}}),
222+
[bump their version]({{p.cmem_plugin_packages_BumpVersions_ref}}),
223+
[publish]({{p.cmem_plugin_packages_PublishPackages_ref}}) them to a Marketplace Server
224+
such as [eccenca.market](https://eccenca.market), and
225+
[install]({{p.cmem_plugin_packages_InstallPackages_ref}}) or
226+
[uninstall]({{p.cmem_plugin_packages_UninstallPackages_ref}}) them on an instance.
227+
228+
- name: Geocoding
229+
icon: ":simple-openstreetmap:"
230+
content: |
231+
{{p.SearchAddresses}} looks up locations from textual descriptions with a configurable
232+
geocoding service, such as [Nominatim](https://nominatim.org/),
233+
[Photon](https://photon.komoot.io/) or the
234+
[French Base Adresse Nationale](https://adresse.data.gouv.fr/).
235+
181236
- name: n8n
182237
icon: ":simple-n8n:"
183238
content: |
@@ -248,6 +303,29 @@ integrations:
248303
[Turtle](https://www.w3.org/TR/turtle/), [RDF/XML](https://www.w3.org/TR/rdf-syntax-grammar/) or
249304
[RDF/JSON](https://www.w3.org/TR/rdf-json/)).
250305
306+
- name: PDF
307+
icon: ":material-file-pdf-box:"
308+
content: |
309+
Read PDF documents with the {{p.binaryFile}} dataset and use
310+
{{p.cmem_plugin_pdf_extract_pdf_extract_PdfExtract}} to get their text and tables.
311+
312+
- name: Text
313+
icon: ":material-text-box:"
314+
content: |
315+
Use the {{p.text}} dataset to read and write plain text files.
316+
317+
- name: Multi CSV ZIP
318+
icon: ":fontawesome-solid-file-csv:"
319+
content: |
320+
Use the {{p.multiCsv}} dataset to read and write multiple CSV files
321+
from and to a single ZIP archive.
322+
323+
- name: Binary Files
324+
icon: ":material-file-outline:"
325+
content: |
326+
Use the {{p.binaryFile}} dataset to read and write files of any format, such as images or
327+
PDF documents, as well as to compress and decompress ZIP archives.
328+
251329
#####
252330
# Databases
253331
#####

0 commit comments

Comments
 (0)