Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Revamped Resource Browser Doc #5035

Merged
merged 9 commits into from May 20, 2024
Merged

doc: Revamped Resource Browser Doc #5035

merged 9 commits into from May 20, 2024

Conversation

ashokdevtron
Copy link
Contributor

@ashokdevtron ashokdevtron commented Apr 30, 2024

Done

  • Repurposed the old content and restructured the whole doc
  • Shifted node operations from another doc to this
  • Removed old cluster doc
  • Added gifs wherever possible
  • Added videos
  • Moved a portion of ephemeral container to this doc
  • Added glossary item for 'K8s object'
  • Included a guide to download pod log
  • Added workload filter and last restart pod log
  • Added redirection from old cluster doc to RB doc
  • Replaced snapshots of node operations
  • Added creatives for easy explanation of node ops
  • RBAC
  • Proofreading (for grammar and errors)

Copy link
Member

@abhibhaw abhibhaw left a comment

Choose a reason for hiding this comment

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

  • RBAC needs to be crosschecked, current mentions concludes, resource browser can only be used by superadmins. (I believe RBAC is pending as per PR description)
  • We should attach more reference links to k8s docs

docs/user-guide/resource-browser.md Outdated Show resolved Hide resolved
docs/user-guide/resource-browser.md Outdated Show resolved Hide resolved
docs/user-guide/resource-browser.md Outdated Show resolved Hide resolved
docs/user-guide/resource-browser.md Outdated Show resolved Hide resolved
docs/user-guide/resource-browser.md Outdated Show resolved Hide resolved
docs/user-guide/resource-browser.md Outdated Show resolved Hide resolved
docs/user-guide/resource-browser.md Outdated Show resolved Hide resolved
docs/user-guide/resource-browser.md Show resolved Hide resolved
docs/user-guide/resource-browser.md Outdated Show resolved Hide resolved
docs/user-guide/resource-browser.md Outdated Show resolved Hide resolved
@abhibhaw
Copy link
Member

abhibhaw commented May 7, 2024

Request someone from @devtron-labs/devops-team to review this doc.

@ashokdevtron
Copy link
Contributor Author

Request someone from @devtron-labs/devops-team to review this doc.

Reviewed by @ajaydevtron on May 10th

Copy link
Member

@abhibhaw abhibhaw left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

gitguardian bot commented May 20, 2024

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
10220829 Triggered Generic High Entropy Secret 82cf580 charts/devtron/devtron-bom.yaml View secret
10220829 Triggered Generic High Entropy Secret 82cf580 charts/devtron/values.yaml View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. 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


🦉 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.

@ashokdevtron ashokdevtron merged commit c690247 into main May 20, 2024
6 checks passed
@ashokdevtron ashokdevtron deleted the revamped-res-browser branch May 20, 2024 10:12
Copy link

sonarcloud bot commented May 20, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants