Skip to content

Commit 24e0564

Browse files
authored
Merge pull request #251 from eccenca/feature/harmonize-various-styles-and-language-CMEM-8037
harmonize product naming across the documentation
2 parents c0b3d36 + 31fe7e3 commit 24e0564

236 files changed

Lines changed: 10754 additions & 2910 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.

‎.claude/docs-guidelines/repo-conventions.md‎

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

126129
## Images
127130

‎.github/workflows/pages.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,28 @@ jobs:
7070
- name: install packages
7171
run: sudo apt-get install -y libffi-dev libz-dev
7272

73+
- name: install lychee
74+
env:
75+
LYCHEE_VERSION: "0.24.2"
76+
LYCHEE_ASSET: lychee-x86_64-unknown-linux-gnu
77+
LYCHEE_RELEASES: https://github.com/lycheeverse/lychee/releases/download
78+
run: |
79+
curl -sSfL "${LYCHEE_RELEASES}/lychee-v${LYCHEE_VERSION}/${LYCHEE_ASSET}.tar.gz" \
80+
| sudo tar -xz -C /usr/local/bin --strip-components=1 "${LYCHEE_ASSET}/lychee"
81+
lychee --version
82+
83+
- name: load link check cache
84+
uses: actions/cache@v4
85+
with:
86+
path: .lycheecache
87+
# A new key per run saves the updated cache; restore-keys picks up the latest one.
88+
# lychee itself re-checks entries older than max_cache_age (lychee.toml).
89+
key: lychee-${{ github.run_id }}
90+
restore-keys: lychee-
91+
7392
- name: check
93+
env:
94+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7495
run: task check
7596

7697
- name: build

‎.github/workflows/test.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,28 @@ jobs:
6161
- name: test
6262
run: task test:unit
6363

64+
- name: install lychee
65+
env:
66+
LYCHEE_VERSION: "0.24.2"
67+
LYCHEE_ASSET: lychee-x86_64-unknown-linux-gnu
68+
LYCHEE_RELEASES: https://github.com/lycheeverse/lychee/releases/download
69+
run: |
70+
curl -sSfL "${LYCHEE_RELEASES}/lychee-v${LYCHEE_VERSION}/${LYCHEE_ASSET}.tar.gz" \
71+
| sudo tar -xz -C /usr/local/bin --strip-components=1 "${LYCHEE_ASSET}/lychee"
72+
lychee --version
73+
74+
- name: load link check cache
75+
uses: actions/cache@v4
76+
with:
77+
path: .lycheecache
78+
# A new key per run saves the updated cache; restore-keys picks up the latest one.
79+
# lychee itself re-checks entries older than max_cache_age (lychee.toml).
80+
key: lychee-${{ github.run_id }}
81+
restore-keys: lychee-
82+
6483
- name: check
84+
env:
85+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6586
run: task check
6687

6788
- name: Publish Test Results

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ tmp
1010
.python-version
1111
dist/
1212
.env
13+
.lycheecache
1314
*.sw[a-p]
1415
*~
1516

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ The following tools you need locally to get started:
3333

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

3839
On a few OS distributions (e.g. Arch Linux) the tool/binary is named `go-task`.
@@ -114,7 +115,7 @@ On this page is search function for icons available as well.
114115
|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.|
115116
|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.|
116117
|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.|
117-
|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.|
118+
|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.|
118119

119120
</details>
120121

‎Taskfile.yml‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,17 @@ tasks:
118118
- poetry run dec-tool check-zensical-output
119119

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

127133
test:
128134
desc: Run the Python unit test suite

‎data/integrations.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ integrations:
163163
- name: GraphQL
164164
icon: ":simple-graphql:"
165165
content: |
166-
Execute a {{p.cmem_plugin_graphql_workflow_graphql_GraphQLPlugin}} and process the result in a workflow.
166+
Execute a {{p.cmem_plugin_graphql_Query}} and process the result in a workflow.
167167
168168
- name: eMail / SMTP / IMAP
169169
icon: ":material-email-outline:"
@@ -254,7 +254,7 @@ integrations:
254254
- name: eccenca Marketplace
255255
icon: ":eccenca-module-marketplace:"
256256
content: |
257-
Manage [Marketplace Packages](../../develop/packages/index.md) in workflows:
257+
Manage [Marketplace Packages](../../develop/marketplace-packages/index.md) in workflows:
258258
[build package archives]({{p.cmem_plugin_packages_BuildPackages_ref}}),
259259
[bump their version]({{p.cmem_plugin_packages_BumpVersions_ref}}),
260260
[publish]({{p.cmem_plugin_packages_PublishPackages_ref}}) them to a Marketplace Server

0 commit comments

Comments
 (0)