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

docs: ADSys arch explanation #1177

Merged
merged 7 commits into from
Jan 22, 2025
Merged

docs: ADSys arch explanation #1177

merged 7 commits into from
Jan 22, 2025

Conversation

edibotopic
Copy link
Contributor

Adds an architecture explanation for ADSys to the documentation, including a discussion of SSSD's role.

Mermaid is used for rendering the diagrams, which required an extension.

Other minor changes:

  • Slightly rewritten landing page for Explanations
  • Formatting, spelling

UDENG-5808

- mermaid sources in diagrams directory
- readme to explain use of diagrams
- explanation page for ref arch
just to pass the spellchecker
@edibotopic edibotopic marked this pull request as ready for review January 22, 2025 10:30
@edibotopic edibotopic requested a review from a team as a code owner January 22, 2025 10:30
Copy link
Member

@didrocks didrocks left a comment

Choose a reason for hiding this comment

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

Thanks for the detailed, separated, commits!

I only have one question, nothing on the rest. Ofc, I couldn’t check the mermaid diagrams as there is no rendering here, but we can always iterate over them.

docs/how-to/set-up-ad.md Show resolved Hide resolved
changes "AD client" to "Ubuntu machine" in arch diagrams.
Copy link
Member

@denisonbarbosa denisonbarbosa left a comment

Choose a reason for hiding this comment

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

Looking good! Just a small nitpick...

PS.: Sorry, I added the nitpick on this conversation

@edibotopic
Copy link
Contributor Author

edibotopic commented Jan 22, 2025

@denisonbarbosa -- just to clarify, are you suggesting replacing all instances of "policies" with "GPOs"? For example, we would have: "fetch GPOs" and "relevant GPOs applied". I would agree with that change for consistency.

@denisonbarbosa
Copy link
Member

@denisonbarbosa -- just to clarify, are you suggesting replacing all instances of "policies" with "GPOs"? For example, we would have: "fetch GPOs" and "relevant GPOs applied". I would agree with that change.

Exactly. Either that or the other way around (replacing GPOs w/ policies or group policies). Whatever you think is going to be clearer.

@edibotopic
Copy link
Contributor Author

@didrocks -- I addressed your comment in 10458bb

@denisonbarbosa -- your suggestion was applied in 2388ee4

Copy link
Member

@denisonbarbosa denisonbarbosa left a comment

Choose a reason for hiding this comment

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

Thanks for the changes. Everything looks great now!

@edibotopic edibotopic merged commit 7871b4e into main Jan 22, 2025
4 of 5 checks passed
@edibotopic edibotopic deleted the ref-arch-explanation branch January 22, 2025 16:18
denisonbarbosa added a commit that referenced this pull request Jan 23, 2025
PR #1177 introduced a new .md file in docs/diagrams. However, this file
is a guide as to how to use the diagram tooling rather than adsys
documentation, so we need to ignore that directory as well in the test
checks.
denisonbarbosa added a commit that referenced this pull request Jan 23, 2025
PR #1177 introduced a new .md file in docs/diagrams. However, this file
is a guide to how to use the diagram tooling rather than adsys
documentation, so we need to ignore that directory as well in the test
checks.
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.

3 participants