docs: polish, installation guide, Suite+ bridge, stub deprecations#757
Merged
Conversation
Add 17 new draft pages (admin + user/basics + user/finder + user/reporting)
and rewrite 11 existing pages so every article now satisfies the
docupike GUIDELINES.md style:
- Title, Abstract, two or more sections, Further readings / Siehe auch.
- One sentence per line in Markdown source.
- US-American English in docs/en, formal Sie throughout docs/de.
- No em-dashes or en-dashes; product names (Suite+, i-doit up,
Add-on, Servereye) keep English spelling in German prose, German
technical nouns (Mandant, Sync-Symbol) replace DeepL artefacts.
Add 14 new screenshots under docs/{en,de}/img/user/.
Pages affected:
- admin: addons, category-builder, class-collection-management,
custom-categories, custom-classes, permissions, rights-and-permissions,
subscription, tenants, user-management
- user/basics: categories-and-attributes, classes, collections,
create-object, dhcp-scopes, empty-states, favorites, ip-networking,
ipam, locations, notifications, object-details, object-tools, objects,
profile, quick-tours, tenant-switcher, top-bar, user-menu
- user/finder: bulk-actions, bulk-modals, class-list, finder,
preset-configuration, saved-views, search-filters-and-reports,
set-filter
- user/reporting: report-manager
- landing: index.md (EN + DE)
Replace the previous SaaS-only installation placeholder with a complete self-hosted setup guide for i-doit up using Docker Compose. The guide covers prerequisites, latest-version lookup, archive download, optional SHA-256 + GPG integrity verification, .env configuration with the full list of required environment variables, HTTPS notes, license token, container start, update, uninstall, and a quick-start checklist. Tested with i-doit up 3.1.0 on Debian 13 (amd64).
Document how i-doit up connects to Suite+ via the bridge add-on. Covers what the bridge synchronises (assets/objects, SSO, embedded documentation), where to find the settings page, layout of the single-row settings table, why the manual Sync trigger is permanently disabled (everything runs through webhooks), per-object jump via the "Open in Suite+" widget, what flows in each direction (create / title change / delete events plus tenant lifecycle), single sign-on JWT exchange, and locale-follows-the-user behaviour for embedded data. Includes four screenshots: the settings page, the widget on a mapped object, the widget on an unmapped object, and the right-side widgets pane.
Seven legacy stub pages (per language) are removed and replaced by
redirects to the new replacement content:
- admin/users-groups-roles -> admin/user-management
- user/basics/enable-disable-attributes -> user/basics/categories-and-attributes
- user/basics/widgets -> user/basics/object-details
- user/finder/inline-editing -> user/finder/bulk-actions
- user/finder/multi-editing -> user/finder/bulk-actions
- user/basics/menubar -> user/basics/top-bar (already redirected, stub removed)
- user/finder/views-and-presets -> user/finder/preset-configuration
(already redirected, stub removed)
Also fix the orphan link in admin/servereye.md (EN+DE) that pointed at
the removed users-groups-roles.md and now points at user-management.md.
Drop the corresponding nav entries from the sidebar in both
i18n/en/mkdocs.yml and i18n/de/mkdocs.yml so the same page is no
longer shown twice ("Users, groups and roles" + "User management").
ljuergenliemke
approved these changes
May 20, 2026
- Update broken cross-link in docs/{en,de}/user/gdpr.md that pointed at
the now-deleted user/finder/views-and-presets.md; the new target is
user/finder/finder.md.
- Pin mkdocs-redirects in requirements.txt so the new redirect_maps
entries (admin/users-groups-roles, user/finder/inline-editing,
user/finder/multi-editing, user/basics/enable-disable-attributes,
user/basics/widgets) resolve in the CI build.
MichaelOv
force-pushed
the
polish-and-cleanup-2026-05-20
branch
from
5aaf66e to
bae71c0
Compare
Spelling (cspell, en_US):
- Convert UK spellings introduced by the polish pass back to en-US:
colour -> color, coloured -> colored, behaviour -> behavior,
Behaviour -> Behavior, categorised -> categorized,
customised -> customized, summarised -> summarized,
organisation -> organization, visualises -> visualizes,
visualisation -> visualization.
- Normalise the network terminology: Subnetwork(s) and subnetwork(s)
become Subnet(s) / subnet(s) for consistency with the rest of the
IPAM page.
- Fix the lowercase "synetics" in admin/addons.md (proper company
name is Synetics).
- Add Synetics, GRC, SEPA, WSL, favoriting and Deutsch to
i18n/en/spelling.txt so legitimate proper nouns and acronyms pass.
Wording (alex):
- Reformulate the "She does not need any direct right assignment"
example into a pronoun-free sentence in rights-and-permissions.md.
- Drop or replace "just" in four narrative sentences (ipam, object-
details, tenant-switcher, preset-configuration).
- Whitelist three rule IDs in .alexrc.yaml (invalid, black, bigger)
for UI terms that are reproduced verbatim from the application
("disabled state", "black bar", "the bigger picture").
editorconfig-checker requires every left-padding to be a multiple of 4. The polish pass had introduced 2-space continuation indents (for "- " bullets) and 3-space continuation indents (for "1. " ordered lists), plus 2-space nested bullets in preset-configuration. Re-indent all continuation/nested lines to the next multiple of 4 so the EC linter passes without changing visible Markdown rendering.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
GUIDELINES.md(Title/Abstract/2+ Sections/Further readings, one sentence per line, no em-dashes, formal Sie in DE, glossary).users-groups-roles,enable-disable-attributes,widgets,inline-editing,multi-editing,menubar,views-and-presets) withredirect_mapsentries and nav cleanup; one orphan cross-link inadmin/servereye.mdfixed.compare.htmlEN/DE side-by-side viewer,mkdocs-redirectspinned inrequirements.txt, leftover polish on gdpr/csv/login/reporting.Commits
dd67830624e037c6285cf8ec0eac5aaf66eTest plan