Skip to content

docs: add onboarding how-to guide for new organizations - #328

Merged
ralphbean merged 3 commits into
mainfrom
docs/onboarding-guide
Apr 24, 2026
Merged

docs: add onboarding how-to guide for new organizations#328
ralphbean merged 3 commits into
mainfrom
docs/onboarding-guide

Conversation

@rh-hemartin

Copy link
Copy Markdown
Member

Summary

  • Adds docs/onboarding.md with step-by-step instructions for installing fullsend in a new GitHub org
  • Covers prerequisites, GCP service account setup, running the installer, merging enrollment PRs, and testing the pipeline
  • Documents gotchas discovered during manual testing (dispatch token permissions, partial install recovery)

Closes #327

Test plan

  • Review doc accuracy against current fullsend admin install flow
  • Verify gcloud commands produce a valid sa-key.json

🤖 Generated with Claude Code

@rh-hemartin
rh-hemartin force-pushed the docs/onboarding-guide branch from f6af6d1 to ee29f00 Compare April 22, 2026 14:40
@github-actions

github-actions Bot commented Apr 22, 2026

Copy link
Copy Markdown

Site preview

Preview: https://928113f9-site.fullsend-ai.workers.dev

Commit: 24de93e3e461bee9fd4fbf5a73a5fdf98d82b563

Closes #327

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Hector Martinez <hemartin@redhat.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Hector Martinez <hemartin@redhat.com>
@rh-hemartin
rh-hemartin force-pushed the docs/onboarding-guide branch from f8efa6f to ce72aaf Compare April 22, 2026 15:02
ralphbean added a commit that referenced this pull request Apr 22, 2026
Remove docs/guides/admin/installing-fullsend.md — the onboarding guide
in #328 covers the same ground. Update links to point to the expected
location (docs/guides/admin/installation.md) once #328 is relocated.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@ralphbean

ralphbean commented Apr 22, 2026

Copy link
Copy Markdown
Member

Hey Hector — I've been working on a documentation structure in #332 (ADR 0023) that splits user docs into docs/guides/admin/ (for org administrators) and docs/guides/user/ (for developers). Your onboarding guide is a great fit for the admin section.

Could you move docs/onboarding.md to docs/guides/admin/installation.md? That way both PRs land cleanly in the same structure. #332 already links to that path and has the index page set up.

@ralphbean ralphbean left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for writing this — the guide is clear and well-structured. A few changes requested plus one note for later.

Comment thread docs/guides/admin/installation.md
Comment thread docs/guides/admin/installation.md Outdated
Comment thread docs/guides/admin/installation.md
Comment thread docs/guides/admin/installation.md
Comment thread docs/guides/admin/installation.md
Align with documentation structure from PR #332 (ADR 0023).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Hector Martinez <hemartin@redhat.com>
@rh-hemartin

Copy link
Copy Markdown
Member Author

/review

@fullsend-ai-review fullsend-ai-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review: #328

Head SHA: 24de93e
Timestamp: 2026-04-24T00:00:00Z
Outcome: comment-only

Summary

This is a well-structured documentation PR that adds an admin installation guide at docs/guides/admin/installation.md. The guide follows the project's documentation structure (ADR 0023), uses environment variables for all sensitive values as required by CLAUDE.md, and documents real gotchas (dispatch token permissions, partial install recovery). The CLI flags in the example commands match the actual Go source in internal/cli/admin.go. No security concerns — no secrets, no code changes, no injection patterns detected. A few minor observations are noted below.

Findings

Medium / Low / Info

  • [correctness] docs/guides/admin/installation.md:28 — Commented-out gh repo create line in a code block may confuse readers. It is unclear whether this is an optional step the reader should consider running or a leftover. Consider either removing it or adding a brief comment explaining when a reader would need it (e.g., "uncomment if the repo doesn't exist yet").
    Remediation: Replace # gh repo create ... with a prose note above the code block, or add an explicit inline comment like # Optional: create the repo if it doesn't exist yet.

  • [intent-alignment] — Issue #327 specifically mentions documenting the gotcha that "target repos must have at least one commit before enrollment (#326)", but this guide does not include that information. This was an explicit request in the issue body.
    Remediation: Add a note (e.g., in a "Gotchas" section or as a callout in the enrollment step) that target repos must contain at least one commit before enrollment.

  • [style] docs/guides/admin/installation.md:1 — The document title is "How to onboard a new organization" but the filename is installation.md and the guides README refers to it as "Installing fullsend". Minor naming inconsistency across the three references.
    Remediation: Align the title with the filename — e.g., "Installing fullsend in a new organization" — or rename the file to match the current title.

  • [correctness] — The PR body states the file path as docs/onboarding.md, but the actual file is docs/guides/admin/installation.md. This is cosmetic (the correct file is committed) but the description is inaccurate.

Footer

Outcome: comment-only
This review applies to SHA 24de93e3e461bee9fd4fbf5a73a5fdf98d82b563. Any push to the PR head clears this review and requires a new evaluation.

@ralphbean ralphbean left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🥳

@ralphbean
ralphbean added this pull request to the merge queue Apr 24, 2026
Merged via the queue into main with commit f4c3174 Apr 24, 2026
2 checks passed
@ralphbean
ralphbean deleted the docs/onboarding-guide branch April 24, 2026 20:15
gbenhaim pushed a commit to gbenhaim/fullsend that referenced this pull request Apr 27, 2026
Remove docs/guides/admin/installing-fullsend.md — the onboarding guide
in fullsend-ai#328 covers the same ground. Update links to point to the expected
location (docs/guides/admin/installation.md) once fullsend-ai#328 is relocated.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

Add onboarding how-to guide for new organizations

2 participants