Skip to content

docs: Drafted Software Distribution Hub #5459

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

Merged
merged 12 commits into from
Jul 23, 2024
Merged

docs: Drafted Software Distribution Hub #5459

merged 12 commits into from
Jul 23, 2024

Conversation

ashokdevtron
Copy link
Contributor

  • Created dedicated section (README.md, tenants.md, release-hub.md)
  • Created an entry in SUMMARY.md
  • Showed tenants as a prerequisite to releasehub-related actions
  • Added Enterprise tagging
  • Added visuals (snapshots, gifs, videos)
  • Explained the purpose in README.md (Why and when and who)
  • Gave examples wherever necessary for the user-input fields
  • Explained rescind and on-hold actions in Extras
  • Showed Partial Release and Full Release in Extras
  • Included RBAC (super-admin as of now)

@ashokdevtron ashokdevtron added the documentation Improvements or additions to documentation label Jul 8, 2024
@ashokdevtron ashokdevtron requested a review from abhibhaw July 8, 2024 13:34
@ashokdevtron ashokdevtron self-assigned this Jul 8, 2024
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.

I'm not sure if this is planned in next phase but few missing stuff:

  1. How release stages dependency is goverened?
  2. Talk about unmapped environment
  3. Release notes and catalog of tenant and releases
  4. Defining applications at release track (Guessing this will be in next phase of doc)
  5. RBAC for deploying with release is not superadmin anymore (Guessing this will be in next phase of doc)
  6. Release track Dashboard (Guessing this will be in next phase of doc)

@ashokdevtron
Copy link
Contributor Author

I'm not sure if this is planned in next phase but few missing stuff:

  1. How release stages dependency is goverened?
  2. Talk about unmapped environment
  3. Release notes and catalog of tenant and releases
  4. Defining applications at release track (Guessing this will be in next phase of doc)
  5. RBAC for deploying with release is not superadmin anymore (Guessing this will be in next phase of doc)
  6. Release track Dashboard (Guessing this will be in next phase of doc)
  1. Need to discuss with you
  2. Need to discuss with you
  3. Added 👍
  4. Hmm. Didn't get it.
  5. Updated 👍
  6. Need to discuss with you

Copy link

gitguardian bot commented Jul 15, 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 a8f7860 charts/devtron/devtron-bom.yaml View secret
10220829 Triggered Generic High Entropy Secret a8f7860 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 requested a review from abhibhaw July 15, 2024 12:20
abhibhaw
abhibhaw previously approved these changes Jul 22, 2024
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.

Suggested minor changes, can be picked up in next version of this doc too

Co-authored-by: Abhibhaw Asthana <39991296+abhibhaw@users.noreply.github.com>
Co-authored-by: Abhibhaw Asthana <39991296+abhibhaw@users.noreply.github.com>
Copy link

@ashokdevtron ashokdevtron merged commit 9826544 into main Jul 23, 2024
9 checks passed
@ashokdevtron ashokdevtron deleted the sdh-doc branch July 23, 2024 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation PR:Ready-to-Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants