Skip to content

fix entra documentation#3112

Merged
akshaydeo merged 1 commit intomainfrom
04-28-fix_entra_documentation
Apr 28, 2026
Merged

fix entra documentation#3112
akshaydeo merged 1 commit intomainfrom
04-28-fix_entra_documentation

Conversation

@akshaydeo
Copy link
Copy Markdown
Contributor

@akshaydeo akshaydeo commented Apr 28, 2026

Summary

Fixes formatting inconsistencies in the Microsoft Entra ID setup guide to improve readability and ensure consistent MDX rendering.

Changes

  • Reformatted all markdown tables to use aligned column separators for consistent rendering
  • Reformatted multi-attribute <img> tags to use multi-line JSX style
  • Reformatted <Tip>, <Warning>, and <Note> block content to use proper indentation
  • Corrected the API permissions step to specify Application permissions instead of Delegated permissions
  • Cleaned up trailing whitespace, extra blank lines, and inconsistent indentation throughout the document
  • Fixed trailing whitespace in the optionalClaims JSON block

Type of change

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Chore/CI

Affected areas

  • Core (Go)
  • Transports (HTTP)
  • Providers/Integrations
  • Plugins
  • UI (React)
  • Docs

How to test

Review the rendered documentation page for the Microsoft Entra setup guide and verify:

  • Tables render with properly aligned columns
  • Images render correctly with alt text
  • Callout blocks (<Tip>, <Warning>, <Note>) display with correct indentation
  • The API permissions step correctly instructs users to select Application permissions

Breaking changes

  • Yes
  • No

Related issues

Security considerations

None.

Checklist

  • I read docs/contributing/README.md and followed the guidelines
  • I added/updated tests where appropriate
  • I updated documentation where needed
  • I verified builds succeed (Go and UI)
  • I verified the CI pipeline passes locally if applicable

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 28, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 214f2a04-3f73-4839-8cee-6ee145f2eef8

📥 Commits

Reviewing files that changed from the base of the PR and between 379e25d and 1d58726.

📒 Files selected for processing (1)
  • docs/enterprise/setting-up-entra.mdx

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated permission selection instructions in the Enterprise setup guide for accuracy.
    • Enhanced documentation formatting and layout for improved readability.

Walkthrough

Documentation formatting update to docs/enterprise/setting-up-entra.mdx including Markdown table restructuring, callout reformatting, image tag conversion to multi-line JSX, whitespace cleanup, JSON example reformatting, and a permission instruction text change from "Delegated permissions" to "Application permissions" in Step 5.

Changes

Cohort / File(s) Summary
Enterprise Setup Documentation
docs/enterprise/setting-up-entra.mdx
Formatting improvements: wider, consistently aligned Markdown tables; reformatted tip/note/warning callouts with adjusted indentation; converted image tags to multi-line JSX style; removed whitespace artifacts; cleaned up embedded JSON example layout; updated Step 5 permission instruction text from "Delegated permissions" to "Application permissions".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A rabbit's ode to tidy docs:

Tables now align with grace so neat,
Callouts indented, whitespace deleted,
JSON reformatted, clean and sweet,
One permission text that's been updated,
Documentation docs—never been so fated! 🎀

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 04-28-fix_entra_documentation

Comment @coderabbitai help to get the list of available commands and usage tips.

@akshaydeo akshaydeo marked this pull request as ready for review April 28, 2026 11:41
Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link
Copy Markdown
Contributor Author

akshaydeo commented Apr 28, 2026

Merge activity

  • Apr 28, 11:41 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Apr 28, 11:41 AM UTC: @akshaydeo merged this pull request with Graphite.

@github-actions
Copy link
Copy Markdown
Contributor

🧪 Test Suite Available

This PR can be tested by a repository admin.

Run tests for PR #3112

@akshaydeo akshaydeo merged commit 62025ff into main Apr 28, 2026
12 of 17 checks passed
@akshaydeo akshaydeo deleted the 04-28-fix_entra_documentation branch April 28, 2026 11:41
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 28, 2026

Confidence Score: 3/5

Not safe to merge as-is — the permission type change would break user onboarding by making Step 5 impossible to follow.

A P1 documentation bug was introduced: the OIDC scopes listed in Step 5 do not exist as Application permissions in Microsoft Graph, so the guide now gives incorrect instructions that users cannot follow. Two additional P2 stale Okta references also remain unfixed.

docs/enterprise/setting-up-entra.mdx — Step 5 permission type and residual Okta references need correction.

Important Files Changed

Filename Overview
docs/enterprise/setting-up-entra.mdx Documentation reformatting (table alignment, image tags, text wrapping) with one substantive content change — "Delegated" → "Application" permissions — that is incorrect for OIDC scopes; also retains two stale "Okta" references.

Reviews (1): Last reviewed commit: "fix entra documentation" | Re-trigger Greptile

2. Click **Add a permission**
3. Select **Microsoft Graph**
4. Choose **Delegated permissions**
4. Choose **Application permissions**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 Incorrect permission type for OIDC scopes

The instruction was changed to "Application permissions," but the scopes listed immediately after — openid, profile, email, and offline_accessdo not exist as Application permissions in Microsoft Graph. They are Delegated-only scopes tied to user sign-in (authorization code flow). A user following this guide will not find those scopes in the Application permissions picker and will be unable to complete the setup.

The OIDC scopes should be added under Delegated permissions, while the directory-read scopes (User.Read, User.Read.All, GroupMember.Read.All, Group.Read.All) can be added as Application permissions (or Delegated, depending on the intended token flow).

Suggested change
4. Choose **Application permissions**
4. Choose **Delegated permissions**

<img src="/media/user-provisioning/entra-form.png" alt="Create token dialog in Okta" />
<img
src="/media/user-provisioning/entra-form.png"
alt="Create token dialog in Okta"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Stale Okta reference in Entra guide

The alt text still reads "Create token dialog in Okta" — this appears to be copied from the Okta setup guide and was not updated.

Suggested change
alt="Create token dialog in Okta"
alt="Bifrost Entra configuration form"


### Attribute Mappings

Attribute mappings let you translate Okta claim values into Bifrost roles, teams, or business units without restructuring your Okta claims. Bifrost supports three mapping types:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Stale Okta references in Attribute Mappings section

This paragraph still says "Okta claim values" and "Okta claims" twice, despite being inside the Microsoft Entra setup guide.

Suggested change
Attribute mappings let you translate Okta claim values into Bifrost roles, teams, or business units without restructuring your Okta claims. Bifrost supports three mapping types:
Attribute mappings let you translate Entra claim values into Bifrost roles, teams, or business units without restructuring your Entra claims. Bifrost supports three mapping types:

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants