Skip to content

Conversation

@Pranay22077
Copy link

@Pranay22077 Pranay22077 commented Oct 22, 2025

Summary by CodeRabbit

  • Documentation
    • Added a "Managing Secrets" guide covering secure storage, prerequisites, steps to add secrets via the dashboard, referencing secrets in configs with ${secret.NAME}, an example use, and security best practices.
    • Updated site navigation to include the new secrets documentation under User Management & Security.
    • Minor footer structure refined for community links (no visual change).

Signed-off-by: Pranay22077 <pranaygadh_mc24b06_003@dtu.ac.in>
@vercel
Copy link

vercel bot commented Oct 22, 2025

@Pranay22077 is attempting to deploy a commit to the idan lodzki's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link

coderabbitai bot commented Oct 22, 2025

Walkthrough

Adds a new "Managing Secrets" documentation page explaining how to store and reference secrets in OpsiMate, updates the sidebar to include the new page under User Management & Security, and adjusts footer Community HTML rendering in the Docusaurus config.

Changes

Cohort / File(s) Summary
Secrets documentation & navigation
opsimate-docs/docs/secrets.md, opsimate-docs/sidebars.js
Adds docs/secrets.md with overview, prerequisites (Admin), steps to add a secret via the dashboard, reference syntax using ${secret.NAME}, a Grafana-secret example, and security best practices (avoid hardcoding, clear naming, least privilege, rotation). Updates sidebars.js to include the new "secrets" doc under User Management & Security.
Docusaurus footer HTML change
opsimate-docs/docusaurus.config.js
Reworks the footer Community HTML block: replaces a separate nested HTML block for community icons with an inline HTML snippet that renders the GitHub and Slack icons, adjusting surrounding braces/commas; no functional change to output.

Possibly related PRs


📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5efe6cf and aec80f9.

📒 Files selected for processing (1)
  • opsimate-docs/docusaurus.config.js (1 hunks)
🔇 Additional comments (1)
opsimate-docs/docusaurus.config.js (1)

124-149: Inconsistency: Footer changes unrelated to PR objectives.

The PR objectives state this PR "adds a screts.md file and linked it in Sidebar," but the changes in this file only restructure the footer's Community section HTML. These footer modifications appear completely unrelated to adding secrets documentation or sidebar links.

Additionally, the PR title contains a typo: "screts.md" should be "secrets.md".

Technical assessment of the footer changes:
The HTML restructuring itself is technically sound—proper accessibility attributes, security headers (rel="noopener noreferrer"), and consistent CSS class naming. However, bundling unrelated changes creates confusion and makes the PR harder to review and maintain.

Recommendations:

  1. Clarify why footer changes are included in a PR about secrets documentation
  2. Consider separating unrelated changes into different PRs for clearer history
  3. Fix the typo in the PR title

Note: The other files mentioned in the AI summary (secrets.md and sidebars.js) were not provided for review, so I cannot verify whether the actual secrets documentation changes are correct.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d4282ba and 78ce2ae.

📒 Files selected for processing (2)
  • opsimate-docs/docs/secrets.md (1 hunks)
  • opsimate-docs/sidebars.js (1 hunks)
🔇 Additional comments (5)
opsimate-docs/sidebars.js (1)

89-89: LGTM! Proper placement in the navigation.

The 'secrets' documentation is correctly added to the User Management & Security category, which is the appropriate location for secrets management documentation.

opsimate-docs/docs/secrets.md (4)

1-5: LGTM! Front matter is correctly configured.

The front matter follows Docusaurus conventions with appropriate id, title, and sidebar position.


7-19: LGTM! Clear overview and important prerequisite.

The overview effectively explains the purpose of secrets management, and the admin privilege requirement is properly highlighted using Docusaurus admonition syntax.


21-31: LGTM! Clear step-by-step instructions.

The instructions for adding secrets are well-structured and easy to follow, with an appropriate UI screenshot reference.


33-42: LGTM! Comprehensive usage context.

The section effectively describes where secrets can be used, providing helpful context for various use cases.

Signed-off-by: Pranay22077 <pranaygadh_mc24b06_003@dtu.ac.in>
@Pranay22077
Copy link
Author

@idanlodzki
I have corrected the requested issues and created a PR
Kindly review it

Thanks

@idanlodzki
Copy link
Contributor

@Pranay22077 please add some images from the system to the documentation

@Pranay22077
Copy link
Author

Sure @idanlodzki
Will make the desired changes

Thanks

@Pranay22077
Copy link
Author

Hi @idanlodzki , I'm trying to add the screenshot for the Secrets documentation, but I can't find the 'Settings -> Secrets' page in the UI when running it locally. Could you point me to where I can find the screen for adding/managing secrets so I can capture it?
Thanks!

@idanlodzki
Copy link
Contributor

@Pranay22077
image

Signed-off-by: Pranay <pranaygadh_mc24b06_003@dtu.ac.in>
@idanlodzki
Copy link
Contributor

@Pranay22077 please dont use ai, go and run opsimate, add secrets and play with the system

@idanlodzki idanlodzki closed this Oct 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants