Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
a7b786b
harmonize product naming across the documentation
annamakor Aug 26, 2026
e1be9f0
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Aug 27, 2026
f118ba6
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Aug 27, 2026
248a64c
Merge remote-tracking branch 'origin/main' into feature/harmonize-var…
rpietzsch Sep 3, 2026
e4b6fb3
Merge remote-tracking branch 'origin/main' into feature/harmonize-var…
rpietzsch Sep 3, 2026
d2cf825
Merge remote-tracking branch 'origin/main' into feature/harmonize-var…
rpietzsch Sep 9, 2026
0fa571c
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Sep 9, 2026
4e3a50d
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Sep 9, 2026
a7d7fb9
Merge remote-tracking branch 'origin/main' into feature/harmonize-var…
rpietzsch Sep 10, 2026
7a269a4
apply missed naming harmonization (Eccenca -> eccenca)
rpietzsch Sep 10, 2026
b43e2b7
Merge remote-tracking branch 'origin/main' into feature/harmonize-var…
rpietzsch Sep 11, 2026
125f8b0
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Sep 16, 2026
663b425
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Sep 18, 2026
c056655
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Sep 21, 2026
3c4094b
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Sep 23, 2026
c830d2e
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Sep 23, 2026
a7a1889
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Sep 23, 2026
59a4a80
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Sep 26, 2026
3259965
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 1, 2026
9f0451d
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 1, 2026
b6a90bc
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 1, 2026
e17ce2c
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 2, 2026
4f87830
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 2, 2026
81f3cd7
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 2, 2026
ae87b34
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 8, 2026
d5ad0bc
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 9, 2026
757235e
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 9, 2026
96dfff3
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 11, 2026
625986b
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Oct 13, 2026
3fe7028
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Nov 2, 2026
d6d4c40
Merge branch 'main' into feature/harmonize-various-styles-and-languag…
rpietzsch Nov 10, 2026
0c93cbc
Merge remote-tracking branch 'origin/main' into feature/harmonize-var…
rpietzsch Nov 11, 2026
d69f528
update cmemc command and Build task and operator references, CMEM-8037
rpietzsch Nov 11, 2026
e3f707d
apply product naming to pages merged from main, CMEM-8037
rpietzsch Nov 11, 2026
5d8a405
use full product name on first mention, drop CMEM from prose, CMEM-8037
rpietzsch Nov 11, 2026
206699e
update cmem-client API reference, CMEM-8037
rpietzsch Nov 12, 2026
5081eb0
satisfy yamllint
rpietzsch Nov 12, 2026
6bd7df3
update shape docu
rpietzsch Nov 12, 2026
9056528
fix yaml output
rpietzsch Nov 12, 2026
8055161
replace linkcheckmd with lychee for the link check, CMEM-8037
rpietzsch Nov 12, 2026
31fe7e3
exclude x.com from the link check, CMEM-8037
rpietzsch Nov 12, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .claude/docs-guidelines/repo-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,10 @@ Do not write `index.html` stubs under `docs/`.
- No absolute links to `https://documentation.eccenca.com/latest/...` for internal pages.
- No base-relative links such as `/automate/...`.
- Same-page references use a plain anchor: `[Configure OAuth clients](#configure-oauth-clients-helm)`, never a full path back to the same file.
- `task check:links` runs the link checker; `task build` runs `zensical build --strict` and fails on unresolved internal links.
- `task check:links` runs [lychee](https://lychee.cli.rs/) over the outgoing http(s) links; exclusions and accepted
status codes live in `lychee.toml`. `task build` runs `zensical build --strict` and fails on unresolved internal links.
- An IRI written as an autolink (`<https://vocab.eccenca.com/...>`) is checked like any link. Identifier namespaces
that do not resolve are excluded in `lychee.toml`; add a new one there rather than formatting the IRI differently.

## Images

Expand Down
21 changes: 21 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,28 @@ jobs:
- name: install packages
run: sudo apt-get install -y libffi-dev libz-dev

- name: install lychee
env:
LYCHEE_VERSION: "0.24.2"
LYCHEE_ASSET: lychee-x86_64-unknown-linux-gnu
LYCHEE_RELEASES: https://github.com/lycheeverse/lychee/releases/download
run: |
curl -sSfL "${LYCHEE_RELEASES}/lychee-v${LYCHEE_VERSION}/${LYCHEE_ASSET}.tar.gz" \
| sudo tar -xz -C /usr/local/bin --strip-components=1 "${LYCHEE_ASSET}/lychee"
lychee --version

- name: load link check cache
uses: actions/cache@v4
with:
path: .lycheecache
# A new key per run saves the updated cache; restore-keys picks up the latest one.
# lychee itself re-checks entries older than max_cache_age (lychee.toml).
key: lychee-${{ github.run_id }}
restore-keys: lychee-

- name: check
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: task check

- name: build
Expand Down
21 changes: 21 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,28 @@ jobs:
- name: test
run: task test:unit

- name: install lychee
env:
LYCHEE_VERSION: "0.24.2"
LYCHEE_ASSET: lychee-x86_64-unknown-linux-gnu
LYCHEE_RELEASES: https://github.com/lycheeverse/lychee/releases/download
run: |
curl -sSfL "${LYCHEE_RELEASES}/lychee-v${LYCHEE_VERSION}/${LYCHEE_ASSET}.tar.gz" \
| sudo tar -xz -C /usr/local/bin --strip-components=1 "${LYCHEE_ASSET}/lychee"
lychee --version

- name: load link check cache
uses: actions/cache@v4
with:
path: .lycheecache
# A new key per run saves the updated cache; restore-keys picks up the latest one.
# lychee itself re-checks entries older than max_cache_age (lychee.toml).
key: lychee-${{ github.run_id }}
restore-keys: lychee-

- name: check
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: task check

- name: Publish Test Results
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ tmp
.python-version
dist/
.env
.lycheecache
*.sw[a-p]
*~

Expand Down
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ The following tools you need locally to get started:

- [poetry](https://python-poetry.org/)
- [task](https://taskfile.dev/)
- [lychee](https://lychee.cli.rs/) - the link checker behind `task check:links`
- git, markdown editor

On a few OS distributions (e.g. Arch Linux) the tool/binary is named `go-task`.
Expand Down Expand Up @@ -114,7 +115,7 @@ On this page is search function for icons available as well.
|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.|
|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.|
|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.|
|Task|The Task admonition type is used to describe a series of steps or tasks required to complete a process or action. Clear and concise descriptions of each step, along with any relevant details or instructions, should be included. It's helpful to use images or diagrams to illustrate the process. Overall, The Task admonition is useful for providing detailed instructions to readers.|Loading Data into a CMEM involves 3 steps: </br> 1. Connect to the database. </br> 2. Choose the data file and appropriate file type. </br> 3. Run workflow to import.|
|Task|The Task admonition type is used to describe a series of steps or tasks required to complete a process or action. Clear and concise descriptions of each step, along with any relevant details or instructions, should be included. It's helpful to use images or diagrams to illustrate the process. Overall, The Task admonition is useful for providing detailed instructions to readers.|Loading Data into eccenca Corporate Memory involves 3 steps: </br> 1. Connect to the database. </br> 2. Choose the data file and appropriate file type. </br> 3. Run workflow to import.|

</details>

Expand Down
14 changes: 10 additions & 4 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,11 +118,17 @@ tasks:
- poetry run dec-tool check-zensical-output

check:links:
desc: Check outgoing links
deps:
- install
desc: Check outgoing links (lychee, configured in lychee.toml)
summary: |
Checks the outgoing http(s) links of the Markdown sources under docs/
with lychee. Exclusions, accepted status codes and retries are set in
lychee.toml. Set GITHUB_TOKEN to avoid GitHub rate limits.
Shows a progress bar in a terminal; in CI (CI is set) it prints the summary only.
preconditions:
- sh: command -v lychee
msg: "lychee is not installed - see https://lychee.cli.rs/installation/ (e.g. brew install lychee)"
cmds:
- poetry run linkcheckMarkdown -r docs 2>&1 | grep -v "ResourceWarning"
- lychee --config lychee.toml ${CI:+--no-progress} 'docs/**/*.md'

test:
desc: Run the Python unit test suite
Expand Down
4 changes: 2 additions & 2 deletions data/integrations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ integrations:
- name: GraphQL
icon: ":simple-graphql:"
content: |
Execute a {{p.cmem_plugin_graphql_workflow_graphql_GraphQLPlugin}} and process the result in a workflow.
Execute a {{p.cmem_plugin_graphql_Query}} and process the result in a workflow.

- name: eMail / SMTP / IMAP
icon: ":material-email-outline:"
Expand Down Expand Up @@ -254,7 +254,7 @@ integrations:
- name: eccenca Marketplace
icon: ":eccenca-module-marketplace:"
content: |
Manage [Marketplace Packages](../../develop/packages/index.md) in workflows:
Manage [Marketplace Packages](../../develop/marketplace-packages/index.md) in workflows:
[build package archives]({{p.cmem_plugin_packages_BuildPackages_ref}}),
[bump their version]({{p.cmem_plugin_packages_BumpVersions_ref}}),
[publish]({{p.cmem_plugin_packages_PublishPackages_ref}}) them to a Marketplace Server
Expand Down
Loading
Loading