-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Connections docs overhaul #15266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
paulOsinski
wants to merge
22
commits into
DefectDojo:bugfix
Choose a base branch
from
paulOsinski:connections-docs-overhaul
base: bugfix
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Connections docs overhaul #15266
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
199a4e8
add initial connections menu entry
paulOsinski e210127
change weighting
paulOsinski e206852
change weighting
paulOsinski ece7b04
docs: redesign documentation site UI
devGregA 654bf70
docs: fix active nav link contrast on navy header
devGregA 33d72c0
docs: remove baked-in canvas from dark-mode logo
devGregA 17d5ca1
stop os/pro switch flicker on page load
paulOsinski 45a89b5
docs: let hero search button take its accessible name from visible text
paulOsinski 1ebef9d
docs: fix sidebar clipping and focus-ring artifacts
devGregA 2cff536
docs: keep breadcrumbs on a single line
devGregA 2e471cc
create about_connections.md
paulOsinski fbc8c38
add downstream connections pro content
paulOsinski aa6cacb
move legacy jira content
paulOsinski 7ca4cd0
change downstream title schema
paulOsinski 83eee45
add upstream content and parent about page
paulOsinski 893b2c8
point internal links directly at new /connections/ paths
paulOsinski 80c2083
align Connections terminology across glossary, feature lists, and com…
paulOsinski a5e2488
fold issue_tracking section into connections
paulOsinski 695de95
add PagerDuty to Downstream Connections reference and vendor lists
paulOsinski e0a54c9
make internal links root-relative and fix dead self-links
paulOsinski 1e8be20
fix screenshots for add_edit_connectors
paulOsinski c06c5f9
update integrators screenshot
paulOsinski File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 headingsKeyboard 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).