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

Revise Entra report header with new exclusion info and documentation name #1529

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

Conversation

schrolla
Copy link
Collaborator

@schrolla schrolla commented Jan 23, 2025

🗣 Description

Changes the header in the CreateReport.psm1 module that generates the header of the Entra HTML report so no longer references the README file, but rather the overall documentation. Also adds a sentence to better explain what an exclusion is and why it is useful.

💭 Motivation and context

The Entra report should provide up-to-date and accurate information for users to understand their options and point to the current documentation.

Closes #1457

🧪 Testing

Run Invoke-SCuBA -p aad with valid credentials to generate an Entra HTML report. View the report and verify that the new language is visible, correct, and the new link works.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • All future TODOs are captured in issues, which are referenced in code comments.
  • These code changes follow the ScubaGear content style guide.
  • Related issues these changes resolve are linked preferably via closing keywords.
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant repo and/or project documentation updated to reflect these changes.
  • Unit tests added/updated to cover PowerShell and Rego changes.
  • Functional tests added/updated to cover PowerShell and Rego changes.
  • All relevant functional tests passed.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.

  • Feature branch has been rebased against changes from parent branch, as needed

    Use Rebase branch button below or use this reference to rebase from the command line.

  • Resolved all merge conflicts on branch

  • Notified merge coordinator that PR is ready for merge via comment mention

  • Demonstrate changes to the team for questions and comments.
    (Note: Only required for issues of size Medium or larger)

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@schrolla schrolla added the documentation This issue or pull request improves or adds to documentation label Jan 23, 2025
@schrolla schrolla added this to the Lionfish milestone Jan 23, 2025
@schrolla schrolla self-assigned this Jan 23, 2025
@schrolla schrolla requested review from tkol2022 and ehaines1 January 23, 2025 17:43
@schrolla schrolla marked this pull request as ready for review January 23, 2025 17:44
Copy link
Collaborator

@tkol2022 tkol2022 left a comment

Choose a reason for hiding this comment

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

Slightly tweaked the first sentence so that it matches up with the language we have in the config file documentation. Also we don't support exclusions for roles. Only users and groups can be excluded from policies.
Nice work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Top paragraph of Entra Id report needs to be updated to reflect new user documentation structure
2 participants