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.

Sign up for GitHub

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

Jump to bottom

docs: Approval Policy (Phase 1) #35

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: Approval Policy (Phase 1) #35

wants to merge 3 commits into from

Conversation

ashokdevtron
Copy link
Contributor

@ashokdevtron ashokdevtron commented Jan 27, 2025 •
edited
Loading

  • Unlinked Protect Configuration doc
  • Linked Approval Policy doc
  • Enterprise tag included
  • RBAC added
  • Snapshots of results shown at the end of the doc
  • Changes and snapshots of Base/Environment Configuration (DT, CM, Secret) will be part of a different PR (Phase 2)

@ashokdevtron ashokdevtron added the documentation Improvements or additions to documentation label Jan 27, 2025
@ashokdevtron ashokdevtron self-assigned this Jan 27, 2025
@ashokdevtron ashokdevtron requested review from a team as code owners January 27, 2025 16:40
@ashokdevtron ashokdevtron requested a review from abhibhaw January 27, 2025 16:40
abhibhaw
abhibhaw requested changes Jan 28, 2025
View reviewed changes
Copy link
Member

@abhibhaw abhibhaw left a comment •
edited by ashokdevtron
Loading

Choose a reason for hiding this comment

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

  • The result should have protect configuration cases? (Added)
  • What happens if multiple policies are applied. (Added a section)
  • How to apply / remove multiple policies (Added a section)
  • Should talk about filters / listing (Didn't explain, but demonstrated while applying/removing policies)
  • Should talk about how to create user group (Didn't explain, but linked to user permissions doc)
  • Whenever you raise a feature PR, probably an index map should be autogenerated to figure out where exactly this doc is falling in the global doc tree (@bhushan-nemade-dt let's see if we can do something on this)
  • Other behaviours when user is deleted, permission revoked (Added as a hintblock)
  • Any impact of removing policies and drafts (Added after experimenting, please check for correctness. Draft removal will be picked up in phase 2 as a part of Base Configurations doc revamp)
  • Approve using email (Added in results section)
  • Notifications (Mentioned, but not explained because there is already a gif attached)

@abhibhaw, added my comments and marked the done items from my side.

@ashokdevtron ashokdevtron changed the title doc: Approval Policy (Phase 1) docs: Approval Policy (Phase 1) Feb 6, 2025
@ashokdevtron ashokdevtron requested a review from abhibhaw February 6, 2025 12:06
abhibhaw
abhibhaw approved these changes Feb 25, 2025
View reviewed changes
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abhibhaw abhibhaw abhibhaw approved these changes

At least 2 approving reviews are required to merge this pull request.

Assignees

@ashokdevtron ashokdevtron

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ashokdevtron @abhibhaw