doc: improve ROSI navigation and scope notes#191
Conversation
Why Add a practical ROSI Collector tutorial to the main docs so users can preview and reuse the stack setup from the rsyslog documentation tree. Impact Adds a new tutorial page plus supporting screenshots to the docs build. Before/After Before: ROSI deployment guidance lived in deployment docs only. After: tutorials now include a guided ROSI stack walkthrough. Technical Overview Convert the upstream community tutorial into rsyslog .rst format. Keep the overall setup flow, screenshots, and operator tasks intact. Rewrite the prose so it reads like native rsyslog documentation. Generalize provider-specific wording into hosting-neutral guidance. Rename the copied image assets to neutral file names. Register the new tutorial in the tutorials index and EXTRA_DIST. Validate the page with a clean HTML documentation build. With the help of AI-Agents: Codex
…orial doc: add ROSI stack deployment tutorial
Why Make the ROSI docs easier to navigate from beginner and deployment entry points, and clarify the Windows integration scope. Impact Adds cross-links and one Windows scope note in ROSI docs. Before/After Before: the guided ROSI tutorial was harder to discover. After: ROSI landing pages point readers to the walkthrough and set Windows expectations more clearly. Technical Overview Link the ROSI Collector index to the guided tutorial from Quick Start. Add the tutorial to the See Also section on the same page. Clarify that Windows Agent integration covers log ingestion only. Point the ROSI beginner page to the guided walkthrough. Keep the changes localized to navigation and explanatory text. Validate the result with a clean HTML documentation build. With the help of AI-Agents: Codex
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the ROSI documentation by improving navigation and clarifying key integration details. The primary goal is to make it easier for users to get started with ROSI Collector through a new guided deployment tutorial, while also providing clearer scope notes for Windows integration. These changes aim to streamline the user experience and reduce potential confusion for new and existing users alike. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the ROSI documentation by adding a comprehensive, guided walkthrough for deploying the ROSI Collector stack. The new tutorial is well-structured, providing clear step-by-step instructions, command examples, and helpful explanations for prerequisites, architecture, client setup, and troubleshooting. The updates to the navigation (index.rst files) ensure that the new tutorial is easily discoverable. Additionally, the clarification regarding Windows integration scope is a valuable improvement for users. Overall, these changes enhance the usability and clarity of the ROSI documentation.
📖 Documentation Preview Ready!✅ Sphinx docs built and deployed for this PR. 🌐 Browse Online (Recommended):🔗 Quick Links:
🤖 This comment was generated by the docs workflow. |
Why Clarify that ROSI is broader than the current collector profile while stating clearly where turnkey packaging stands today. Impact Updates ROSI overview pages with clearer scope, maturity, and ecosystem positioning. Before/After Before: ROSI could read too much like a synonym for ROSI Collector. After: ROSI is framed as long-standing practice, clearer guidance, and growing artifacts, with ROSI Collector as the main packaged profile. Technical Overview Rework high-level ROSI pages rather than the onboarding tutorial. Explain that freedom of choice and parallel destinations have long been possible with rsyslog in practice. Position ROSI as a formalization of that approach plus clearer operational guidance. State that ROSI Collector is the primary packaged artifact today. Name broader destination and Windows-side component families explicitly. Add linked first mentions for Adiscon and related product home pages on the pages touched. Validate the result with a clean HTML documentation build. With the help of AI-Agents: Codex
1 participant
Summary
Improve ROSI docs navigation and clarify the Windows integration scope.
What changed
Validation