Skip to content

docs: restore EN screenshot paths flipped to DE in KB overhaul (42 articles)#1313

Merged
MichaelOv merged 20 commits into
mainfrom
restore-en-screenshots
Jun 16, 2026
Merged

docs: restore EN screenshot paths flipped to DE in KB overhaul (42 articles)#1313
MichaelOv merged 20 commits into
mainfrom
restore-en-screenshots

Conversation

@MichaelOv

@MichaelOv MichaelOv commented Jun 5, 2026

Copy link
Copy Markdown
Member

Summary

Commit 9df48ca (KB overhaul, 2026-04-08) bulk-replaced pre-existing EN image references with DE ones across many EN articles. The English screenshots still lived physically under overrides/assets/images/en/; only the markdown references pointed to the German tree.

This PR restores the EN paths where the original EN counterpart still applies, and adds fresh v38 EN captures where no parallel English image existed. Articles outside the touched set still render with their existing DE screenshots (unchanged behavior vs. main).

What this PR covers

19 commits, 86 files, 343 image refs restored to EN.

Highlights:

Commit Topic Image refs Approach
669b9b87 initial 42-article overhaul restore 242 path rewrite, OCR-verified
24bf455d web-gui 13 fresh v38 captures
c7d24d1f attribute-fields + Add button 1 fresh capture
35fd7388 cmdb-explorer service-filter level 1 1 fresh capture
e8dfbac7 maintenance email template 1 fresh capture
812d3dd8 api endpoint documentation 1 fresh capture
fe3c1a40 / 0c908f00 snmp (OID-numeric, language-neutral) 4 path + fresh captures
1dd7a953 switch-stacking 3 fresh v38 captures (stack member, logical ports, cross-stack parent port)
78b3e348 object-list (4 articles) 19 path rewrite + fresh advanced-settings.png
bd1c2546 viva2 (4 articles) 12 path rewrite to existing EN parallels
ccfbe27b adfs-saml, flows 26 path rewrite (DE files pixel-identical to EN)
aa8057d8 report-manager 15-rm 1 path rewrite

Plus earlier f24cfbe0, ab3b76d1, 0ef68aa2, 917ee551, 07c35a75, 453e8b6c covering 22 more refs across various pages.

Out of scope (kept on DE path)

50 EN articles in the overhaul set still reference DE images (~501 refs total). These articles have no parallel EN tree file and need fresh captures from a configured v38 environment. The DE images still render until replaced. Follow-up tracked separately.

Specifically blocked by missing test environments:

  • azure-ad-saml.md (20 refs) — no Azure portal access available
  • microsoft-windows-server install screenshot — no Windows Server VM
  • dashboard-and-widgets.md (73 refs) — needs configured dashboards with real data
  • vm-provisioning.md (36) — needs vCenter setup

Test plan

  • CI build green
  • Local mkdocs preview: spot-check 5 modified pages render English screenshots
  • No broken image links: all 343 new EN paths verified to point at existing files in working tree
  • Untouched articles still render their DE screenshots (no regression)

Affects 42 articles where commit 9df48ca ("KB overhaul: SEO optimization,
new articles, EN translation", 2026-04-08) bulk-replaced pre-existing
EN image references with DE ones, even though the EN versions still
exist physically under overrides/assets/images/en/.

For each modified file, pre-overhaul EN refs were extracted from the
state at 9df48ca^ and matched against current DE refs by image basename;
matching paths were swapped from images/de/ back to images/en/.

Verification: each replacement target was OCR-checked (tesseract,
deu+eng) for the actual UI language. 232 of 236 unique pairs confirmed
English (161 by clear EN tokens, 65 with no UI text but visually
verified by sample, 6 SVG icons byte-identical to DE counterpart).

4 EN files were found to still show German UI despite living in /en/;
those 4 specific references were NOT changed and kept the original
de/ path. They need new EN screenshots created:
  - en/evaluation/report-manager/14-rm.png
  - en/automation-and-integration/network-monitoring/nagios/1-nag.png
  - en/automation-and-integration/network-monitoring/nagios/3-nag.png
  - en/automation-and-integration/network-monitoring/nagios/4-nag.png

96 DE refs in these 42 files have no pre-overhaul EN counterpart with
matching basename; left as-is for the editorial follow-up backlog.
@MichaelOv MichaelOv requested a review from a team as a code owner June 5, 2026 11:27
PR #1313 originally left 4 references on the DE path because the
corresponding EN files contained German UI screenshots (verified via
OCR + visual inspection). Replaces those 4 EN files with new
screenshots captured from the v38 i-doit instance running in English
UI, and flips the 4 markdown references from de/ to en/.

New screenshots, dimensions matching the DE originals:

- en/evaluation/report-manager/14-rm.png  (1922x1082)
  Administration > User permissions > Report Manager, with rights
  loaded for 'Person groups > Admin'

- en/automation-and-integration/network-monitoring/nagios/1-nag.png  (1694x814)
  Administration > Import and interfaces > Monitoring > Export
  configuration, editing 'Nagios Host #1'

- en/automation-and-integration/network-monitoring/nagios/3-nag.png  (1905x1021)
  CMDB > Server > __RackServer_1 > Host definition (Nagios Host
  category) with Export parameter section filled

- en/automation-and-integration/network-monitoring/nagios/4-nag.png  (1694x814)
  Identical to 1-nag.png because the DE source files were byte-
  identical duplicates

Style note: the original DE 14-rm.png used a legacy i-doit UI theme
with a left-side category sidebar that no longer exists in v38; the
new EN screenshot uses the current modern UI.
@MichaelOv MichaelOv self-assigned this Jun 5, 2026
@MichaelOv MichaelOv requested review from Grufthase and ljuergenliemke and removed request for a team June 5, 2026 13:26
Michael Overkamp added 11 commits June 5, 2026 15:34
…del)

7 image refs in 2 articles point to images/de/... but the actual files
there are already language-agnostic (customer portal screenshots in
licensing.md, database schema diagram in software-development).

- licensing.md: 6 customer-portal screenshots (Add-on & Subscription
  Center is English regardless of i-doit UI language)
- software-development/database-model/index.md: 1 ER diagram (no UI
  language)

Files were byte-identical between images/de/<path>/ and
images/en/<path>/, so no new files needed; only the markdown paths
flipped from de/ to en/.
…mages

basics/web-gui.md is the canonical i-doit web-GUI tour. The 13
referenced images were all on images/de/grundlagen/web-gui/ paths
showing the German UI (and an older i-doit 1.19 theme in places).

Captured 13 new screenshots from i-doit v38 in English UI:
  1. Login form
  2. Login with tenant select (from DE source — content already English)
  3. Dashboard (full)
  4. Top bar with object type group selector
  5. my-doit panel
  6. User settings > User interface preferences
  7. Object type group dropdown open
  8. Extras menu dropdown open
  9. Top bar with search focused
 10. User dropdown menu (Administration / Add-on Center / Logout)
 11. Breadcrumb on an object detail page (Server > __RackServer_1)
 12. Object view sidebar (object type tree)
 13. Location view sidebar (location tree)

Annotation note: the DE originals had red boxes/arrows overlaid to
highlight specific UI elements. The new EN captures are unannotated
for now — editorial can add annotations on top of these clean
baselines.
basics/attribute-fields.md references a small button image inline at
the point describing multi-selection in the object browser. The DE
source showed a 'Hinzufügen' button.

Captured the equivalent '+ Add' button from v38 EN UI (58x33 px), saved
at images/en/basics/attribute-fields/hinzufuegen.png (basename kept to
avoid additional markdown edits — can be renamed in a follow-up if
desired).
Captured Extras > Services > Service filter > Level 1 in v38 EN UI
showing the same filter conditions (relation types, priority,
object types, depth, CMDB status).
Maintenance add-on > Email templates > edit a template, showing Title,
Text, Report properties (Global/Specific/Custom tabs), Chosen
attributes panel and Available placeholders section.
Administration > Add-ons > JSON-RPC API > Endpoint documentation in
v38 EN, showing the Cmdb Category / Cmdb External / Cmdb Object-type-
group endpoint summaries with Expand all / Collapse all controls.
…ish)

The DE source at images/de/.../service-desk/3-sd.png shows an i-doit
1.8 PRO 'All Tickets' category view; all visible labels (Subject,
Queue, Status, Priority, Date created, Owner, Requestor, Object
category, Linked objects) are already in English. No new screenshot
needed; just copied to images/en/.../service-desk/ and flipped the
markdown reference.

Note: this v38 instance has no Service Desk integration module
installed (RT/OTRS/Zammad), so a current EN re-capture of the All
Tickets view isn't possible from here. The legacy English screenshot
remains accurate for the article's purpose.
…ostly language-neutral)

2-snmp.png and 3-snmp.png show the SNMP category on a Router object
with OIDs and SNMP results. Content is mostly numeric (1.3.6.1.2.1...
OIDs) and English data fields. The German UI section labels
(Beschreibung / SNMP-Ergebnis / Hinzufügen) remain; a clean EN
re-capture is in the backlog when an i-doit instance with a populated
SNMP community + router is available.
2-sws, 3-sws, 4-sws show Stack Members category and Logical Ports
on a Stacking object. Most of the visible text is data values
(switch names, ports, IPs, layer-2 net) which is already in English.
The German UI labels (Standortsicht, Modus, Aktiv/Passiv, Logische
Ports, Bezeichnung) remain.

A clean EN re-capture requires a fully bootstrapped Stacking object
with member switches and logical ports — not feasible to set up
quickly without a demo dataset; marked as backlog.
zielobjektgruppen / zielobjekte / schutzbedarf-anzeigen /
schutzbedarf-editieren show small cropped views of the VIVA2 IT-
Grundschutz protection assessment UI on an Informationsverbund.

The VIVA2 add-on is installed in this v38 instance but reproducing
the exact view requires a fully-configured Informationsverbund with
target objects/groups and protection-needs entries — not feasible to
set up quickly. Existing files copied to EN tree; clean EN re-capture
backlogged for whenever a configured VIVA2 demo dataset is
available.
2-ol.gif (301 frames, 2258x817) and 3-ol.gif (81 frames, 2560x1297)
are animated screencasts of object-list UI interactions, not static
screenshots. Re-recording in v38 EN requires a browser screen-capture
workflow (ffmpeg+Playwright video → GIF, or similar) which is beyond
the static-screenshot tooling used so far.

Files copied to EN tree as placeholders; the animation content is
mostly mouse motion and UI element interaction which translates
language-neutrally to most readers.
Michael Overkamp added 5 commits June 5, 2026 17:20
Previous commit fe3c1a4 placed DE-source files in the EN tree as
placeholders. This commit overwrites them with proper screenshots
captured from v38 in English UI:

- 2-snmp.png: SNMP category on a Router with 5 OID rows
  (1.3.6.1.2.1.1.1.0, .2.2.1.2.1, .2.2.1.14.1, .1.4.0, .1.3.0)
- 3-snmp.png: same view with OID column replaced by SNMP-walk results
  (Firewall description, em0 interface, Counter32:0, Not Care Team,
  Timeticks)

Note: php8.3-snmp extension was required and installed; the SNMP
category page rendered empty without it.
…ptures

- 2-sws.png: stack member overview from JDisc-imported SW-STACK-ACCESS
- 3-sws.png: logical Ports list view on SW-STACK-A02
- 4-sws.png: logical Port edit form with cross-stack parent port assignment
… advanced settings

- action-bar.md: 6 image refs rewritten to actions-in-object-lists/N-aiol.png
- configure-list-view.md: 6 refs (3 SVG + 3 PNG) to configuration-of-the-list-view/N-cotlv.*
- navigate-and-filter.md: 6 refs (3 PNG/GIF + 3 SVG) to navigation-and-filtering/
- advanced-settings.md: new v38 EN capture of User interface settings page
- it-grundschutz-check.md: 4 refs (it-grundschutz-check-example, basic-requirements-example, edit-requirement-example, basic-protection-reached-example)
- it-grundschutz-profiles.md: 3 refs (profile-overview/create/apply)
- structural-analysis.md: 3 refs (targetobjectgroup-example, adjusted-network, communication-link)
- modeling.md: 2 refs to distinct EN files (process-modules + assigned-modules) instead of the same image twice as in DE source
DE-source files are pixel-identical to EN tree counterparts:
- adfs-saml: AD FS Management Console UI is English-only
- flows install/update steps: same screenshots already mirrored under EN tree
Michael Overkamp added 2 commits June 16, 2026 12:15
Resolved conflict in docs/en/i-doit-add-ons/flows/index.md by taking main's
version: that article was rewritten upstream and no longer references the
install/update-step images this branch had restored.
@MichaelOv

Copy link
Copy Markdown
Member Author

Follow-up tracked in #1321 for the 50 articles + ~501 refs that need fresh EN captures.

@MichaelOv MichaelOv merged commit 1b85f79 into main Jun 16, 2026
7 checks passed
@MichaelOv MichaelOv deleted the restore-en-screenshots branch June 16, 2026 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants