Skip to content

Commit 812f289

Browse files
authored
Merge pull request #300 from eccenca/feature/restructure-build-documentation-CMEM-8189
group the Build navigation into four sections, CMEM-8189
2 parents 98de7ea + 0025642 commit 812f289

26 files changed

Lines changed: 568 additions & 545 deletions

File tree

‎docs/build/.pages‎

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,30 @@
11
---
22
nav:
33
- Build: index.md
4-
- Introduction to the User Interface: introduction-to-the-user-interface
5-
- Integrations: integrations
6-
- Task and Operator Reference: reference
7-
- Mapping Creator: mapping-creator
8-
- Mapping Creator Tutorial: mapping-creator-tutorial
9-
- Rule Operators: rule-operators
10-
- Rule Blocks: rule-blocks
11-
- Define Prefixes / Namespaces: define-prefixes-namespaces
12-
- Cool IRIs: cool-iris
13-
- Lift Tabular Data: lift-data-from-tabular-data-such-as-csv-xslx-or-database-tables
14-
- Lift Hierarchical Data: lift-data-from-json-and-xml-sources
15-
- Lift Web API Data: extracting-data-from-a-web-api
16-
- Workflows: workflows
17-
- Incremental Database Loading: loading-jdbc-datasets-incrementally
18-
- Connect to Snowflake: snowflake-tutorial
19-
- Active learning: active-learning
20-
- Link Intrusion Detection Systems to Open-Source INTelligence: tutorial-how-to-link-ids-to-osint
21-
- Variables: variables
22-
- Evaluate Template Operator: evaluate-template
23-
- Build Knowledge Graphs from Kafka Topics: kafka-consumer
24-
- Run Catalog Queries in Workflows: query-catalog-tasks
25-
- Spark: spark
26-
- Project Access Control: project-access-control
4+
- Foundations:
5+
- Introduction to the User Interface: introduction-to-the-user-interface
6+
- Cool IRIs: cool-iris
7+
- Define Prefixes / Namespaces: define-prefixes-namespaces
8+
- Rule Operators: rule-operators
9+
- Spark: spark
10+
- Tutorials:
11+
- Mapping Creator Tutorial: mapping-creator-tutorial
12+
- Lift Tabular Data: lift-data-from-tabular-data-such-as-csv-xslx-or-database-tables
13+
- Lift Hierarchical Data: lift-data-from-json-and-xml-sources
14+
- Lift Web API Data: extracting-data-from-a-web-api
15+
- Incremental Database Loading: loading-jdbc-datasets-incrementally
16+
- Connect to Snowflake: snowflake-tutorial
17+
- Build Knowledge Graphs from Kafka Topics: kafka-consumer
18+
- Run Catalog Queries in Workflows: query-catalog-tasks
19+
- Evaluate Template Operator: evaluate-template
20+
- Link Intrusion Detection Systems to Open-Source INTelligence: tutorial-how-to-link-ids-to-osint
21+
- Guides:
22+
- Mapping Creator: mapping-creator
23+
- Active learning: active-learning
24+
- Rule Blocks: rule-blocks
25+
- Workflows: workflows
26+
- Variables: variables
27+
- Project Access Control: project-access-control
28+
- Reference:
29+
- Task and Operator Reference: reference
30+
- Integrations: integrations

‎docs/build/index.md‎

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,52 +9,60 @@ hide:
99

1010
# :material-star: Build
1111

12-
The Build stage turns your source data—across files, databases, APIs, and streams—into an Enterprise Knowledge Graph. The sections below explain the Build workspace and guide you from first lifting steps to reusable patterns and reference material.
12+
The Build stage turns source data from files, databases, APIs, and streams into an Enterprise Knowledge Graph.
1313

1414
**:octicons-people-24: Intended audience:** Linked Data Experts
1515

1616
<div class="grid cards" markdown>
1717

18-
- :eccenca-application-dataintegration: Foundations: Introduction and Best Practices
18+
- :material-lightbulb-outline: Foundations
1919

2020
---
2121

22-
- [Introduction to the User Interface](introduction-to-the-user-interface/index.md) --- a short introduction to the **Build** workspace incl. projects and tasks management.
23-
- [Rule Operators](rule-operators/index.md) --- Overview on operators that can be used to build linkage and transformation rules.
24-
- [Cool IRIs](cool-iris/index.md) --- URIs and IRIs are character strings identifying the nodes and edges in the graph. Defining them is an important step in creating an exploitable Knowledge Graph for your Company.
25-
- [Define Prefixes / Namespaces](define-prefixes-namespaces/index.md) --- Namespace declarations allow for abbreviation of IRIs by using a prefixed name instead of an IRI, in particular when writing SPARQL queries or Turtle.
26-
- [Spark](spark/index.md) --- Explainer of Apache Spark and its integration within the BUILD platform.
27-
- [Project Access Control](project-access-control/index.md) --- Restrict a project to the members of selected user groups.
22+
Understand the workspace and the concepts behind it.
23+
24+
- [Introduction to the User Interface](introduction-to-the-user-interface/index.md) --- The **Build** workspace, its projects and its tasks.
25+
- [Cool IRIs](cool-iris/index.md) --- Define the identifiers of the nodes and edges in a Knowledge Graph.
26+
- [Define Prefixes / Namespaces](define-prefixes-namespaces/index.md) --- Abbreviate IRIs with prefixed names.
27+
- [Rule Operators](rule-operators/index.md) --- The operators that make up linking and transformation rules.
28+
- [Spark](spark/index.md) --- Apache Spark and its integration in **Build**.
2829

2930
- :material-list-status: Tutorials
3031

3132
---
3233

34+
Follow an example from start to finish.
35+
3336
- [Build a mapping with the Mapping Creator](mapping-creator-tutorial/index.md) --- Map a hierarchical XML file to a vocabulary with the visual editor and its AI-generated suggestions.
34-
- [Lift Data from Tabular Data](lift-data-from-tabular-data-such-as-csv-xslx-or-database-tables/index.md) --- Build a Knowledge Graph from tabular data such as CSV, XSLX or database tables.
35-
- [Lift data from JSON and XML sources](lift-data-from-json-and-xml-sources/index.md) --- Build a Knowledge Graph based on input data from hierarchical sources such as JSON and XML files.
36-
- [Extracting data from a Web API](extracting-data-from-a-web-api/index.md) --- Build a Knowledge Graph based on input data from a Web API.
37-
- [Incremental Database Loading](loading-jdbc-datasets-incrementally/index.md) --- Load data incrementally from a JDBC Dataset (relational database Table) into a Knowledge Graph.
38-
- [Active learning](active-learning/index.md) --- Advanced workflows that improve results iteratively by incorporating feedback signals.
39-
- [Connect to Snowflake](snowflake-tutorial/index.md) --- Connect Snowflake as a scalable cloud warehouse and lift/link its data in Corporate Memory to unify it with your other sources in one knowledge graph.
40-
- [Build Knowledge Graphs from Kafka Topics](kafka-consumer/index.md) --- Consume Kafka topics and lift event streams into a Knowledge Graph.
41-
- [Evaluate Jinja Template and Send an Email Message](evaluate-template/index.md) --- Template and send an email after a workflow execution.
37+
- [Lift Data from Tabular Data](lift-data-from-tabular-data-such-as-csv-xslx-or-database-tables/index.md) --- Build a Knowledge Graph from CSV, XLSX or database tables.
38+
- [Lift data from JSON and XML sources](lift-data-from-json-and-xml-sources/index.md) --- Build a Knowledge Graph from hierarchical files.
39+
- [Extracting data from a Web API](extracting-data-from-a-web-api/index.md) --- Build a Knowledge Graph from a Web API response.
40+
- [Incremental Database Loading](loading-jdbc-datasets-incrementally/index.md) --- Load a relational database table incrementally through a JDBC dataset.
41+
- [Connect to Snowflake](snowflake-tutorial/index.md) --- Lift and link data from a Snowflake cloud warehouse.
42+
- [Build Knowledge Graphs from Kafka Topics](kafka-consumer/index.md) --- Consume Kafka topics and lift event streams.
43+
- [Evaluate Jinja Template and Send an Email Message](evaluate-template/index.md) --- Fill a template from a graph and send it after a workflow execution.
4244
- [Link Intrusion Detection Systems to Open-Source INTelligence](tutorial-how-to-link-ids-to-osint/index.md) --- Link IDS data to OSINT sources.
4345

44-
- :fontawesome-regular-snowflake: Patterns
46+
- :material-wrench-outline: Guides
4547

4648
---
4749

48-
- [Reconfigure Workflow Tasks](workflows/index.md) --- During its execution, new parameters can be loaded from any source, which overwrites originally set parameters.
49-
- [Project and Global Variables](variables/index.md) --- Define and reuse variables across tasks and projects.
50-
- [Rule Blocks](rule-blocks/index.md) --- Build re-usable, function-like transformation sequences which are referenced from transformation and linking rules and managed centrally.
50+
Use a feature in a project.
51+
52+
- [Mapping Creator](mapping-creator/index.md) --- Create and manage mappings on a visual canvas.
53+
- [Active learning](active-learning/index.md) --- Learn a linking rule from interactively labeled record pairs.
54+
- [Rule Blocks](rule-blocks/index.md) --- Build reusable transformation sequences, referenced from transformation and linking rules and managed centrally.
55+
- [Workflows](workflows/index.md) --- Orchestrate datasets and tasks, and reconfigure tasks during execution.
56+
- [Variables](variables/index.md) --- Define and reuse global, project and execution variables.
57+
- [Project Access Control](project-access-control/index.md) --- Restrict a project to the members of selected user groups.
5158

5259
- :material-book-open-variant-outline: Reference
5360

5461
---
5562

56-
- [Mapping Creator](mapping-creator/index.md) --- Create and manage mappings to lift legacy data into a Knowledge Graph.
57-
- [Integrations](integrations/index.md) --- Supported integrations and configuration options for connecting data sources and sinks.
58-
- [Task and Operator Reference](reference/index.md) --- Reference documentation for tasks and operators in the Build workspace.
63+
Look up tasks, operators and supported services.
64+
65+
- [Task and Operator Reference](reference/index.md) --- Tasks and operators of the **Build** workspace.
66+
- [Integrations](integrations/index.md) --- Services and applications that integrate with Corporate Memory.
5967

6068
</div>

‎docs/build/integrations/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ sign-in or a bearer token, see [Agent Integration](../../automate/agent-integrat
111111

112112
---
113113

114-
Manage [Marketplace Packages](../../develop/packages/index.md) in workflows:
114+
Manage [Marketplace Packages](../../develop/marketplace-packages/index.md) in workflows:
115115
[build package archives](../../build/reference/customtask/cmem_plugin_packages-BuildPackages.md),
116116
[bump their version](../../build/reference/customtask/cmem_plugin_packages-BumpVersions.md),
117117
[publish](../../build/reference/customtask/cmem_plugin_packages-PublishPackages.md) them to a Marketplace Server

‎docs/build/rule-blocks/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Conversely, a rule which uses a rule block stays small and readable, because the
2525
Since a rule block is a regular project item, it travels with the project:
2626
it is contained in project exports and imports, and it can be shipped inside a [Marketplace Package](../../distribution/marketplace/index.md).
2727
This makes rule blocks a natural carrier for conventions which should not be re-invented per project or per team - an IRI minting rule which implements your [Cool IRI](../cool-iris/index.md) policy, a normalization of company names, or the canonical way to build a label.
28-
Published as [a package](../../develop/packages/index.md), such a set of rule blocks becomes a shared, versioned guideline which other units or organizations install instead of re-implementing.
28+
Published as [a package](../../develop/marketplace-packages/index.md), such a set of rule blocks becomes a shared, versioned guideline which other units or organizations install instead of re-implementing.
2929

3030
!!! info "Availability"
3131

@@ -213,7 +213,7 @@ To use the same rule block elsewhere, distribute the project item:
213213
See the [project command group](../../automate/cmemc-command-line-interface/command-reference/project/index.md) of [cmemc](../../automate/cmemc-command-line-interface/index.md).
214214
- **Marketplace Packages** - a package which ships a Build project ships its rule blocks with it.
215215
This is the way to publish a set of agreed-upon rule blocks - IRI minting, name and address normalization, code cleanup - as a versioned artifact which other teams install.
216-
See [Marketplace Packages: Development and Publication](../../develop/packages/development/index.md) and the [Marketplace](../../distribution/marketplace/index.md).
216+
See [Marketplace Packages: Development and Publication](../../develop/marketplace-packages/development/index.md) and the [Marketplace](../../distribution/marketplace/index.md).
217217

218218
## Limitations
219219

‎docs/develop/.pages‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ nav:
33
- Develop: index.md
44
- Accessing Graphs with Java Applications: accessing-graphs-with-java-applications
55
- Python Plugins: python-plugins
6-
- Marketplace Packages: packages
6+
- Marketplace Packages: marketplace-packages
77
- cmempy - Python API: cmempy-python-api
88
- cmem-client - Python API: cmem-client-api
99
- cmemc - Python Scripts: cmemc-scripts

‎docs/develop/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Extend eccenca Corporate Memory with custom plugins and packages, and access it
2525

2626
---
2727

28-
[Marketplace Packages](packages/index.md) bundle existing content (graphs, Build projects, dependencies, ...) into a single shareable artifact. [Create your own packages](packages/development/index.md) for easy distribution and reuse.
28+
[Marketplace Packages](marketplace-packages/index.md) bundle existing content (graphs, Build projects, dependencies, ...) into a single shareable artifact. [Create your own packages](marketplace-packages/development/index.md) for easy distribution and reuse.
2929

3030
- :material-api: OpenAPI specification
3131

File renamed without changes.
File renamed without changes.

docs/develop/packages/development/tutorial/index.md renamed to docs/develop/marketplace-packages/development/tutorial/index.md

File renamed without changes.

0 commit comments

Comments
 (0)