Upstream/Downstream Connectors docs overhaul - #15266
Conversation
![accesslint[bot]](https://avatars.githubusercontent.com/in/1502?s=60&v=4){kind=small}
| const storedVersion = localStorage.getItem("version") || "opensource"; | ||
| console.log("[VersionToggle] Stored version:", storedVersion); | ||
| setVersion(storedVersion); | ||
| // custom-head.html already stamped the stored edition on <html> before |
There was a problem hiding this comment.
WCAG 2.4.2: Document is missing a <title> element.
Documents must have a <title> element to provide users with an overview of content.
Details
Page text: "// custom js // Mobile navigation: the site sets doks.bootstrapJavascript = false, so no // Bootstrap plugins load and the header's offcanvas toggles "
Screen reader users rely on page titles to identify and navigate between tabs/windows. Add a descriptive <title> element in <head> that summarizes the page purpose. Keep titles unique across the site, placing specific content before the site name (e.g., 'Contact Us - Acme Corp').
Best Practice: Page has no mechanism to bypass repeated content. Add a <main> landmark or skip link.
Page must have a mechanism to bypass repeated blocks of content.
Details
Missing: no landmarks (<main>, <nav>, <header>, <footer>), no skip link, no headings
Keyboard users must be able to skip repetitive content like navigation. Provide a skip link at the top of the page that links to the main content (e.g., <a href="#main">Skip to main content</a>), or use a <main> landmark. Screen readers can jump directly to landmarks, so a properly marked-up <main> element satisfies this requirement.
Best Practice: Page does not contain a level-one heading.
Page should contain a level-one heading.
Details
A level-one heading (<h1> or role='heading' with aria-level='1') helps users understand the page topic and provides a landmark for screen reader navigation. Each page should have exactly one h1 that describes the main content, typically matching or similar to the page title.
Best Practice: Page has no main landmark.
Page should have exactly one main landmark.
Details
The main landmark contains the primary content of the page. Screen readers allow users to jump directly to main content. Use a single <main> element (or role='main') to wrap the central content, excluding headers, footers, and navigation.
WCAG 3.1.1: <html> element missing lang attribute.
The <html> element must have a lang attribute.
Details
Page text sample: "// custom js // Mobile navigation: the site sets doks.bootstrapJavascript = false, so no // Bootstrap plugins load and the header's offcanvas toggles are dead markup. // Importing the Offcanvas plugin"
Screen readers use the lang attribute to determine which language rules and pronunciation to use. Without it, content may be mispronounced. Set lang to the primary language of the page (e.g., lang='en' for English, lang='es' for Spanish).
| --bs-btn-active-color: #fff; | ||
| font-weight: 500; // Medium for buttons | ||
| } | ||
| // Selected state keys off the edition stamped on <html> before first |
There was a problem hiding this comment.
WCAG 2.4.2: Document is missing a <title> element.
Documents must have a <title> element to provide users with an overview of content.
Details
Page text: "// ============================================================ // DefectDojo Docs design system // // Imported last in doks-core app.scss — everythin"
Screen reader users rely on page titles to identify and navigate between tabs/windows. Add a descriptive <title> element in <head> that summarizes the page purpose. Keep titles unique across the site, placing specific content before the site name (e.g., 'Contact Us - Acme Corp').
Best Practice: Page has no mechanism to bypass repeated content. Add a <main> landmark or skip link.
Page must have a mechanism to bypass repeated blocks of content.
Details
Missing: no landmarks (<main>, <nav>, <header>, <footer>), no skip link, no headings
Keyboard users must be able to skip repetitive content like navigation. Provide a skip link at the top of the page that links to the main content (e.g., <a href="#main">Skip to main content</a>), or use a <main> landmark. Screen readers can jump directly to landmarks, so a properly marked-up <main> element satisfies this requirement.
Best Practice: Page does not contain a level-one heading.
Page should contain a level-one heading.
Details
A level-one heading (<h1> or role='heading' with aria-level='1') helps users understand the page topic and provides a landmark for screen reader navigation. Each page should have exactly one h1 that describes the main content, typically matching or similar to the page title.
Best Practice: Page has no main landmark.
Page should have exactly one main landmark.
Details
The main landmark contains the primary content of the page. Screen readers allow users to jump directly to main content. Use a single <main> element (or role='main') to wrap the central content, excluding headers, footers, and navigation.
WCAG 3.1.1: <html> element missing lang attribute.
The <html> element must have a lang attribute.
Details
Page text sample: "// ============================================================ // DefectDojo Docs design system // // Imported last in doks-core app.scss — everything here wins the // cascade. Selectors defined here"
Screen readers use the lang attribute to determine which language rules and pronunciation to use. Without it, content may be mispronounced. Set lang to the primary language of the page (e.g., lang='en' for English, lang='es' for Spanish).
|
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
|
Conflicts have been resolved. A maintainer will review the pull request shortly. |
Introduce a single top-level Connectors section that merges the former API Connectors (upstream) and Integrations (downstream) docs, adopting "Connectors" as the umbrella term across the docs. - new docs/content/connectors/ section: about, upstream/, downstream/, os_jira/, and issue-tracking overview, moved from import_data/pro/connectors and issue_tracking/ - single "Connectors" top-nav item and homepage card; sectionNav updated - PagerDuty, Linear, and ServiceNow SecOps added to the downstream reference; connector reference deduplicated - align terminology across glossary, feature lists, comparison tables, and asset-modelling pages; add redirect aliases for the old paths Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Replace absolute https://docs.defectdojo.com/... links with root-relative /... paths across parser reference pages and a few other docs, so links resolve within whichever environment (dev/staging/prod) is serving the docs instead of always jumping to the production site. Also fixes a few dead self-links. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
a438cec to
2ec927c
Compare
paulOsinski
changed the title
Restore add_edit_connectors{,_2,_3}.png and integrators_3.png to their
base (bugfix) versions. The refreshed screenshots are no longer part of
this change; the Connectors docs keep the existing images.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2 participants
This PR catches our documentation up with Upstream/Downstream Connectors, a merge of our Integrators and (upstream only) Connectors fields. There's a lot of content here so I'll break it down
out of scope but also included
devdon't get taken to our production site