Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation structure/content (including sidebars) by renaming/removing some examples, adding new example pages, and rewriting several docs sections (jobs, delivery interfaces, administration, installation/backup) to match current product behavior.
Changes:
- Update sidebars to reference new/renamed example docs and remove deprecated example pages.
- Revise multiple docs pages (Jobs, Delivery Interfaces, Administration, Getting Started) with updated UI flows and configuration details.
- Add new docs pages for Kibana conditional reporting and Kibana anomaly alerting; remove older “conditional/statistical/branded reports” pages.
Reviewed changes
Copilot reviewed 78 out of 81 changed files in this pull request and generated 20 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_sidebars/version-stable-sidebars.json | Updates versioned sidebar entries for renamed/removed examples. |
| sidebars.ts | Updates sidebar entries for renamed/removed examples. |
| docs/getting-started/installation.md | Updates Docker/Docker Compose instructions and environment variables. |
| versioned_docs/version-stable/getting-started/installation.md | Versioned equivalent of installation doc updates. |
| docs/getting-started/features.md | Updates edition feature lists and comparison table. |
| versioned_docs/version-stable/getting-started/features.md | Versioned equivalent of features doc updates. |
| docs/getting-started/configuration.md | Reorients configuration guidance toward admin UI steps. |
| versioned_docs/version-stable/getting-started/configuration.md | Versioned equivalent of configuration doc updates. |
| docs/jobs/index.md | Updates AI compatibility wording. |
| versioned_docs/version-stable/jobs/index.md | Versioned equivalent of jobs index wording update. |
| docs/jobs/general.md | Reformats tables and simplifies retry/housekeeping descriptions. |
| versioned_docs/version-stable/jobs/general.md | Versioned equivalent of jobs general updates. |
| docs/jobs/capture.md | Updates capture mode explanations and connector details. |
| versioned_docs/version-stable/jobs/capture.md | Versioned equivalent of capture doc updates. |
| docs/jobs/composer.md | Rewrites composer doc to focus on block types/layout structure. |
| versioned_docs/version-stable/jobs/composer.md | Versioned equivalent of composer doc updates. |
| docs/jobs/delivery.md | Updates delivery content to emphasize email/webhook/S3. |
| versioned_docs/version-stable/jobs/delivery.md | Versioned equivalent of delivery doc updates. |
| docs/delivery-interfaces/index.md | Updates available interfaces list/table and configuration steps. |
| versioned_docs/version-stable/delivery-interfaces/index.md | Versioned equivalent of delivery interfaces index updates. |
| docs/delivery-interfaces/smtp.md | Reformats SMTP configuration/troubleshooting tables. |
| versioned_docs/version-stable/delivery-interfaces/smtp.md | Versioned equivalent of SMTP doc updates. |
| docs/delivery-interfaces/mailgun.md | Updates Mailgun configuration fields and setup steps. |
| versioned_docs/version-stable/delivery-interfaces/mailgun.md | Versioned equivalent of Mailgun doc updates. |
| docs/delivery-interfaces/webhook.md | Updates webhook configuration options and template examples. |
| versioned_docs/version-stable/delivery-interfaces/webhook.md | Versioned equivalent of webhook doc updates. |
| docs/delivery-interfaces/slack.md | Reframes Slack delivery guidance to use webhook interface. |
| versioned_docs/version-stable/delivery-interfaces/slack.md | Versioned equivalent of Slack doc update. |
| docs/delivery-interfaces/s3.md | Reformats S3 doc tables and streamlines content. |
| versioned_docs/version-stable/delivery-interfaces/s3.md | Versioned equivalent of S3 doc updates. |
| docs/basic-examples/index.md | Updates Basic Examples listing to include new conditional report page. |
| versioned_docs/version-stable/basic-examples/index.md | Versioned equivalent of Basic Examples index update. |
| docs/basic-examples/kibana-dashboard-report.md | Updates Kibana dashboard tutorial and references template. |
| versioned_docs/version-stable/basic-examples/kibana-dashboard-report.md | Versioned equivalent of Kibana dashboard tutorial updates. |
| docs/basic-examples/kibana-alert.md | Updates Kibana alert example away from Slack-specific delivery. |
| versioned_docs/version-stable/basic-examples/kibana-alert.md | Versioned equivalent of Kibana alert example updates. |
| docs/basic-examples/grafana-dashboard-report.md | Updates Grafana tutorial steps and authentication wording. |
| versioned_docs/version-stable/basic-examples/grafana-dashboard-report.md | Versioned equivalent of Grafana tutorial updates. |
| docs/basic-examples/kibana-conditional-report.md | Adds new Kibana conditional report tutorial. |
| versioned_docs/version-stable/basic-examples/kibana-conditional-report.md | Versioned equivalent new Kibana conditional report tutorial. |
| docs/advanced-examples/index.md | Updates Advanced Examples list to new anomaly alert example. |
| versioned_docs/version-stable/advanced-examples/index.md | Versioned equivalent of Advanced Examples index update. |
| docs/advanced-examples/mixed-sources-report.md | Updates mixed-sources example with step-by-step UI instructions. |
| versioned_docs/version-stable/advanced-examples/mixed-sources-report.md | Versioned equivalent of mixed-sources updates. |
| docs/advanced-examples/ai-news-collation.md | Updates AI news collation example steps and prompts. |
| versioned_docs/version-stable/advanced-examples/ai-news-collation.md | Versioned equivalent of AI news collation updates. |
| docs/advanced-examples/kibana-anomaly-alert.md | Adds new Kibana anomaly alert example. |
| versioned_docs/version-stable/advanced-examples/kibana-anomaly-alert.md | Versioned equivalent new Kibana anomaly alert example. |
| docs/data-retention/index.md | Simplifies retention overview content. |
| versioned_docs/version-stable/data-retention/index.md | Versioned equivalent of retention overview changes. |
| docs/data-retention/runs.md | Updates run status table. |
| versioned_docs/version-stable/data-retention/runs.md | Versioned equivalent of runs doc changes. |
| docs/data-retention/reports.md | Simplifies reports overview and retention wording. |
| versioned_docs/version-stable/data-retention/reports.md | Versioned equivalent of reports doc changes. |
| docs/administration/index.md | Simplifies administration overview content. |
| versioned_docs/version-stable/administration/index.md | Versioned equivalent of administration index changes. |
| docs/administration/spaces.md | Updates Spaces management and permissions guidance. |
| versioned_docs/version-stable/administration/spaces.md | Versioned equivalent of Spaces doc changes. |
| docs/administration/self-monitoring.md | Updates health monitoring UI path and API endpoint. |
| versioned_docs/version-stable/administration/self-monitoring.md | Versioned equivalent of self-monitoring changes. |
| docs/administration/backup.md | Updates backup approaches and endpoints/volume guidance. |
| versioned_docs/version-stable/administration/backup.md | Versioned equivalent of backup doc changes. |
| docs/administration/authentication/index.md | Updates authentication model to system users + space permissions. |
| versioned_docs/version-stable/administration/authentication/index.md | Versioned equivalent of authentication index changes. |
| docs/administration/authentication/local.md | Updates local auth UI path and user type descriptions. |
| versioned_docs/version-stable/administration/authentication/local.md | Versioned equivalent of local auth changes. |
| docs/administration/authentication/ldap.md | Updates LDAP configuration fields and guidance. |
| versioned_docs/version-stable/administration/authentication/ldap.md | Versioned equivalent of LDAP auth changes. |
| docs/changelog.md | Rewrites changelog content to a 0.9.0 entry. |
| versioned_docs/version-stable/changelog.md | Versioned equivalent of changelog update. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
I went through all the pages and mainly improved the following things:
I left out SAML and OICD auth strategies, as I don't have any experience with them, and getting into them would exceed the scope of this review.
Added the Grafana Feature in the changelog.