docs: separate $-prompt commands from their output in bash code blocks#998
Open
ArnobKumarSaha wants to merge 1 commit into
Open
docs: separate $-prompt commands from their output in bash code blocks#998ArnobKumarSaha wants to merge 1 commit into
ArnobKumarSaha wants to merge 1 commit into
Conversation
Commands now render alone in a ```bash block; command output moves outside the fence as plain text, matching the rest of the docs. Signed-off-by: Arnob kumar saha <arnob@appscode.com>
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 30516367 | Triggered | Curl Username Password | 23ed937 | docs/guides/elasticsearch/configuration/topology-cluster/index.md | View secret |
| 30516353 | Triggered | Curl Username Password | 23ed937 | docs/guides/elasticsearch/clustering/topology-cluster/simple-dedicated-cluster/index.md | View secret |
| 30516353 | Triggered | Curl Username Password | 23ed937 | docs/guides/elasticsearch/clustering/topology-cluster/simple-dedicated-cluster/index.md | View secret |
| 34433003 | Triggered | Generic CLI Secret | 23ed937 | docs/guides/clickhouse/initialization/script_source.md | View secret |
| 30516365 | Triggered | Curl Username Password | 23ed937 | docs/guides/elasticsearch/configuration/combined-cluster/index.md | View secret |
| 30516352 | Triggered | Curl Username Password | 23ed937 | docs/guides/elasticsearch/backup/kubestash/logical/index.md | View secret |
| 30516353 | Triggered | Curl Username Password | 23ed937 | docs/guides/elasticsearch/backup/kubestash/logical/index.md | View secret |
| 34433003 | Triggered | Generic CLI Secret | 23ed937 | docs/guides/clickhouse/initialization/script_source.md | View secret |
| 30516353 | Triggered | Curl Username Password | 23ed937 | docs/guides/elasticsearch/clustering/topology-cluster/simple-dedicated-cluster/index.md | View secret |
| 30516353 | Triggered | Curl Username Password | 23ed937 | docs/guides/elasticsearch/backup/kubestash/logical/index.md | View secret |
| 30516372 | Triggered | Curl Username Password | 23ed937 | docs/guides/elasticsearch/clustering/combined-cluster/index.md | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secrets safely. Learn here the best practices.
- Revoke and rotate these secrets.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
|
Important Review skippedToo many files! This PR contains 747 files, which is 597 over the limit of 150. To get a review, narrow the scope: Upgrade to a paid plan to raise the limit. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (747)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Member
Author
Left untouched — needs manual cleanupThe automated reformat skipped 16 code blocks with pre-existing issues in the source that make an automatic `$ command` / output split unsafe or ambiguous. Listed by current file:line (the opening
Separate pre-existing bug (not related to this PR)
|
tamalsaha
requested changes
Jul 7, 2026
tamalsaha
left a comment
tamalsaha
left a comment
Member
There was a problem hiding this comment.
Do NOT Merge this. This breaks formatting.
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.
Summary
```bashblock, with the command output moved outside the fence as plain text — matching the style used elsewhere in the docs.$/bare commands, stray backticks, etc.) that need manual cleanup, anddocs/guides/druid/volume-expansion/guide.mdwhich has a pre-existing unclosed code fence unrelated to this change.Test plan