Skip to content

docs(iam): rewrite IAM overview to flow better #237

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 1 commit into from
Jul 28, 2025
Merged

Conversation

Xe
Copy link
Contributor

@Xe Xe commented Jul 22, 2025

The IAM overview page was fine, but these rewrites make it easier to read for humans and machines. These changes include:

  • Removing duplication of statements.
  • Stating implicit things explicitly.
  • Removing the pattern of paragraph headers in bullet point lists.
  • Removing the emoji from headers.
  • Removing the horizontal rules between sections.
    • If they need to come back, we should fix this at the CSS level for all headers instead of using horizontal rules, which typically denote the end of one section and the beginning of another.
  • Explicitly noting the difference between Tigris IAM and AWS IAM.
  • Rewriting overall to make things look more "human".
  • Small formatting fixes.

The IAM overview page was fine, but these rewrites make it easier to
read for humans and machines. These changes include:

- Removing duplication of statements.
- Stating implicit things explicitly.
- Removing the pattern of paragraph headers in bullet point lists.
- Removing the emoji from headers.
- Removing the horizontal rules between sections.
  - If they need to come back, we should fix this at the CSS level for
    all headers instead of using horizontal rules, which typically
    denote the end of one section and the beginning of another.
- Explicitly noting the difference between Tigris IAM and AWS IAM.
- Rewriting overall to make things look more "human".
- Small formatting fixes.

Signed-off-by: Xe Iaso <xe@tigrisdata.com>
@Xe Xe requested a review from katieschilling July 22, 2025 16:48
@Xe Xe self-assigned this Jul 22, 2025
Copy link

vercel bot commented Jul 22, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-redirect ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 22, 2025 4:49pm
tigris-os-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 22, 2025 4:49pm

@katieschilling katieschilling merged commit 73b523f into main Jul 28, 2025
10 checks passed
@katieschilling katieschilling deleted the Xe/iam/de-llm branch July 28, 2025 15:52
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