Security rx doc restructuring #22277
Open
+3,462
−93
Conversation
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
Major documentation reorganization to enhance user experience and clarity: ## New Structure - **Getting Started**: Setup and configuration - Overview, Prerequisites, Prioritization, Integrations - **Applications**: Application vulnerability management - Overview, Organization view, Entity view - **Infrastructure**: Infrastructure vulnerability management - Overview, Organization view, Entity (host) view - **Advanced**: Power user features - Alerts, Status management, NRQL queries, Data structure ## Changes ### New Documentation - applications/overview.mdx - Application security overview - infrastructure/overview.mdx - Infrastructure security overview - advanced/data-structure.mdx - NRQL data structure reference - advanced/query-examples.mdx - Ready-to-use NRQL queries ### File Reorganization - Moved all files to logical sections (getting-started, applications, infrastructure, advanced) - Renamed files for clarity (e.g., dev-workflow → monitor-entity-security) - Added 19 redirects from old URLs to new locations ### Content Improvements - Fixed typos: "Prerequisite" → "Prerequisites", "verion" → "version", "mange" → "Manage" - Fixed title error: "security security team" → "Security team" - Updated all internal cross-references to new paths - Improved meta descriptions for SEO - Standardized callout formatting for preview features ## Benefits - Clear separation by use case (applications vs infrastructure) - Separate views for developers and security teams - Better discoverability with overview pages - Advanced users have dedicated section with NRQL documentation - All old URLs redirect to new locations (no broken links) 🤖 Generated with Claude Code https://claude.com/claude-code Co-Authored-By: Claude <[email protected]>
Add contextual "What's Next" sections to improve user journey and discoverability across all major Security RX documentation pages. ## Changes Added "What's Next" sections with DocTiles to 10 pages: ### Getting Started (4 pages) - overview.mdx - Guide to prerequisites, integrations, and choosing workflow - prerequisites.mdx - Next steps after verifying access - prioritization.mdx - Guide to starting vulnerability management - integrations/overview.mdx - Next steps after integration setup ### Applications (2 pages) - manage-organization-vulnerabilities.mdx - Links to entity view, status management, alerts, and NRQL - monitor-entity-security.mdx - Links to org view, prioritization, status management, and alerts ### Infrastructure (2 pages) - manage-infrastructure-vulnerabilities.mdx - Links to host view, status management, alerts, and NRQL - monitor-host-security.mdx - Links to org view, status management, alerts, and integrations ### Advanced (2 pages) - set-up-alerts.mdx - Links to status management, NRQL queries, prioritization, and applications - manage-vulnerability-status.mdx - Links to alerts, NRQL queries, prioritization, and applications ## Benefits - **Improved navigation** - Users can easily discover related content - **Contextual guidance** - Each page suggests logical next steps - **Better user journey** - Clear path from setup to advanced usage - **Reduced bounce rate** - Users stay engaged with relevant content - **Consistent UX** - All major pages have navigation guidance 🤖 Generated with Claude Code https://claude.com/claude-code Co-Authored-By: Claude <[email protected]>
Update the navigation YAML file to reflect the new documentation structure with improved organization and clarity. ## Navigation Changes ### Old Structure - Get started with Security RX - Overview, Prerequisites, Integrations - Understanding vulnerability prioritization (top-level) - Manage vulnerabilities as an engineer - Applications, Infrastructure - Manage vulnerabilities as a security team - Applications, Infrastructure - Change vulnerability status (top-level) - Set up vulnerability alerts (top-level) ### New Structure - Getting started (consolidated setup) - Overview, Prerequisites, Understanding prioritization, Integrations - Security RX for Applications (with overview) - Overview, Manage organization vulnerabilities, Monitor entity security - Security RX for Infrastructure (with overview) - Overview, Manage infrastructure vulnerabilities, Monitor host security - Advanced configuration (power user features) - Set up alerts, Manage vulnerability status, Data structure (NRQL), Query examples (NRQL) ## Key Improvements 1. Role-agnostic organization - Removed "as an engineer" / "as a security team" labels 2. Added overview pages - Each major section now has an overview for better orientation 3. Consolidated setup - All getting started content in one section 4. Added NRQL documentation - New advanced pages for querying security data 5. Better grouping - Alerts and status management grouped under "Advanced" 6. Clearer paths - All paths updated to new file locations ## Path Updates All paths have been updated to match the new directory structure: - overview → getting-started/overview - user-roles → getting-started/prerequisites - integrations/* → getting-started/integrations/* - dev-workflow → applications/monitor-entity-security - security-workflow → applications/manage-organization-vulnerabilities - infra-workflow → infrastructure/monitor-host-security - security-workflow-infra → infrastructure/manage-infrastructure-vulnerabilities - change-vulnerability-status → advanced/manage-vulnerability-status - set-up-alerts → advanced/set-up-alerts Plus 2 new pages: - advanced/data-structure (NEW) - advanced/query-examples (NEW) 🤖 Generated with Claude Code https://claude.com/claude-code Co-Authored-By: Claude <[email protected]>
… docs
Convert all markdown tables to HTML `<table>` components to maintain consistency with existing documentation standards.
## Changes
Converted markdown tables to HTML format in 3 files:
### applications/overview.mdx
- **Supported languages table** (6 rows)
- Converted pipe-delimited markdown to HTML table
- Maintains language, version, and coverage data
- Better rendering consistency
### infrastructure/overview.mdx
- **OS distributions table** (6 rows)
- Converted markdown table with inline images to HTML
- Preserves OS icon images in table cells
- Improves visual consistency with other docs
### advanced/data-structure.mdx
- **Multiple attribute reference tables** (10+ tables converted)
- NrAiIncident attributes
- Vulnerability attributes
- NrAiIncidentTimeline attributes
- Common attributes (entity identification, timestamps, source tracking)
- Severity values, state values, source values
## Format Details
All tables now use consistent HTML structure:
```html
<table>
<thead>
<tr>
<th>Column Name</th>
</tr>
</thead>
<tbody>
<tr>
<td>Cell content</td>
</tr>
</tbody>
</table>
```
## Benefits
- **Consistency** - Matches existing Security RX documentation style
- **Better rendering** - HTML tables provide more reliable cross-browser display
- **Maintainability** - Standard format used throughout New Relic docs
- **Visual quality** - Better spacing, alignment, and styling control
🤖 Generated with Claude Code
https://claude.com/claude-code
Co-Authored-By: Claude <[email protected]>
cbehera-newrelic
added
content
|
Hi @cbehera-newrelic 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. Please ensure the propsed changes look good by building it first in your local environment. Refer to this contribution guide to get the site up and running in your local. If you really require a preview url, reach out to one of the writers and they will generate one for you. |
Contributor
Author
|
netlify build |
🚀 Netlify Preview Building!If the build is successful, the preview for this pull request will be available at the following URL (usually takes 10-20 minutes): https://securityrx-doc-restructuring--docs-website-netlify.netlify.app |
Contributor
Author
|
netlify build |
Contributor
Author
|
netlify build |
1 similar comment
Contributor
Author
|
netlify build |
Contributor
Author
|
netlify build |
1 similar comment
Contributor
Author
|
netlify build |
Contributor
Author
|
netlify build |
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.
No description provided.