Update alt text in Automate docs#4677
Open
IanMadd wants to merge 3 commits into
Open
Conversation
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
✅ Deploy Preview for chef-web-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves accessibility and clarity across the Chef Automate documentation by replacing generic image alt text with more descriptive, content-specific alt text.
Changes:
- Replaced short/placeholder alt text (for example, “Reports”, “Node Integrations”) with descriptive alt text across many Automate docs pages.
- Updated multiple ServiceNow integration docs screenshots with more specific descriptions of dialogs, lists, and outputs.
- Refreshed alt text for architecture/flow diagrams and HA diagrams to better describe key components and relationships.
Reviewed changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| content/automate/users.md | More descriptive alt text for Users settings screenshot. |
| content/automate/upgrade_san_certificates.md | More descriptive alt text for SAN validation output screenshots. |
| content/automate/teams.md | More descriptive alt text for Teams settings screenshot. |
| content/automate/servicenow_reference.md | More descriptive alt text for ServiceNow reference screenshots (including commented section). |
| content/automate/servicenow_incident_creation.md | More descriptive alt text for Incident Creation app flow and setup screenshots. |
| content/automate/servicenow_event_creation.md | More descriptive alt text for Event Creation app navigation/properties/setup screenshots. |
| content/automate/scan_jobs.md | More descriptive alt text for Environment tag screenshot. |
| content/automate/roles.md | More descriptive alt text for Roles settings screenshot. |
| content/automate/reports.md | More descriptive alt text for Reports UI screenshots (overview, date selector, LCR flow, tabs, details). |
| content/automate/projects.md | More descriptive alt text for Projects settings screenshot. |
| content/automate/profiles.md | More descriptive alt text for Profiles UI screenshots (installed/available/details/body). |
| content/automate/policies.md | More descriptive alt text for Policies settings screenshot. |
| content/automate/notifications.md | More descriptive alt text for Notifications UI screenshots (ServiceNow and general navigation). |
| content/automate/node_integrations.md | More descriptive alt text for Node Integrations and cloud manager/scan job screenshots. |
| content/automate/node_credentials.md | More descriptive alt text for Node Credentials and credential form screenshots. |
| content/automate/major_upgrade_4.x.md | More descriptive alt text for v4 upgrade/migration flow diagram. |
| content/automate/large_compliance_report.md | More descriptive alt text for LCR architecture diagram. |
| content/automate/iam_v2_overview.md | More descriptive alt text for IAM v2 policy structure diagram. |
| content/automate/iam_v2_guide.md | More descriptive alt text for IAM v2 UI screenshots (policies/projects/rules/filtering). |
| content/automate/ha.md | More descriptive alt text for HA architecture diagrams (on-prem, AWS managed, min node). |
| content/automate/ha_verification_check.md | More descriptive alt text for HA verify checks output screenshot. |
| content/automate/ha_troubleshooting.md | More descriptive alt text for critical service status screenshot. |
| content/automate/ha_disaster_recovery_setup.md | More descriptive alt text for DR setup diagram (two clusters). |
| content/automate/ha_disaster_recovery_setup_AWS.md | More descriptive alt text for AWS DR deployment diagram. |
| content/automate/event_feed.md | More descriptive alt text for Event Feed UI screenshots (dashboard and icon legend). |
| content/automate/data_lifecycle.md | More descriptive alt text for Data Lifecycle settings screenshot. |
| content/automate/client_runs.md | More descriptive alt text for Client Runs overview screenshot. |
| content/automate/architectural_overview.md | More descriptive alt text for Automate architecture diagram. |
| content/automate/applications_dashboard.md | More descriptive alt text for Applications dashboard screenshots (service groups, filtered view). |
| content/automate/api_tokens.md | More descriptive alt text for API Tokens list screenshot. |
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
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.
Description
[Please describe what this change achieves]
Definition of Done
Issues Resolved
[List any existing issues this PR resolves, or any Discourse or
StackOverflow discussion that's relevant]
Related PRs
Check List