diff --git a/docs/guides/README.md b/docs/guides/README.md index bffb989db..507e185b6 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -8,6 +8,7 @@ Structure decided in [ADR 0023](../ADRs/0023-user-documentation-structure.md). Guides for org administrators who install, configure, and manage fullsend. +- [How to install fullsend](admin/install.md) — A simplified version of the installation guide. - [Installing fullsend](admin/installation.md) — Set up fullsend in a GitHub organization from scratch (see [#328](https://github.com/fullsend-ai/fullsend/pull/328)) - [Enabling fullsend on private repositories](admin/private-repositories.md) — Additional guardrails and configuration for private repos diff --git a/docs/guides/admin/install.md b/docs/guides/admin/install.md new file mode 100644 index 000000000..4913c16f5 --- /dev/null +++ b/docs/guides/admin/install.md @@ -0,0 +1,97 @@ +# How To Install Fullsend + +## Overview + +This guide explains how to install Fullsend, both in organization and repository mode. +We recommend using repository mode as it is simpler. + +Note: this guide is not intended to be a reference for the installation parameters. +It is intended to be simplified version to help you get started and that covers most +of use cases. For a detailed reference of the install command check +[the full install guide](installation.md). + +## Google Cloud Platform (GCP) Project + +Fullsend needs a GCP Project to run the inference. Create it and then enable the following +APIs: + +* [Agent Platform](https://console.cloud.google.com/apis/library/aiplatform.googleapis.com). +* [IAM Credentials](https://console.cloud.google.com/apis/library/iamcredentials.googleapis.com). +* [Cloud Resource Manager](https://console.cloud.google.com/apis/library/cloudresourcemanager.googleapis.com). + +## Local Tools and CLIs + +* Download and authenticate with [`gh`](https://cli.github.com/). +* Download and authenticate with [`gcloud`](https://cloud.google.com/cli). +* Download [`fullsend` CLI](https://github.com/fullsend-ai/fullsend/releases). + +## Install Fullsend GitHub Applications + +Install (or request the installation of) the official Fullsend GitHub applications +into your organization scoped to the repositories you want: + +* [fullsend-ai-coder](https://github.com/apps/fullsend-ai-coder) +* [fullsend-ai-triage](https://github.com/apps/fullsend-ai-triage) +* [fullsend-ai-fullsend](https://github.com/apps/fullsend-ai-fullsend) +* [fullsend-ai-retro](https://github.com/apps/fullsend-ai-retro) +* [fullsend-ai-review](https://github.com/apps/fullsend-ai-review) + +You can continue with the installation, but fullsend won't work until those applications +get installed. + +## Export Variables (optional) + +The commands on this how-to use the bash variable expansion notation to indicate +that you should provide your own values. If you want, you can export these variables +and then copy-paste the commands, otherwise you need to edit the commands before +executing them. Run the following code: + +```bash +export ORG_NAME="" +export REPO_NAME="" +export GCP_PROJECT="" +``` + +## Repository mode installation (recommended) + + +```bash +fullsend admin install $ORG_NAME/$REPO_NAME --inference-project $GCP_PROJECT --mint-url=https://fullsend-mint-gljhbkcloq-uc.a.run.app --skip-mint-check +``` + +This creates the appropriate secrets, variables and files in your repository. + +## Organization mode installation + + +```bash +fullsend admin install $ORG_NAME --inference-project $GCP_PROJECT --mint-url=https://fullsend-mint-gljhbkcloq-uc.a.run.app --skip-mint-check --enroll-none +``` + +This creates the appropriate secrets, variables and files in your organization and repositories. +After installing, enroll the repositories you want with: + +```bash +fullsend admin enable repos $ORG_NAME $REPO_NAME +``` + +## Test Fullsend + +By default Fullsend will: + +* Triage new issues or triage on demand with `/fs-triage` on an issue. +* Implement changes for bugfixes (flagged by triage) or on demand with `/fs-code` on an issue. +* Review changes on new PRs or on demand with `/fs-review` on a PR. +* Automatically address PR feedback (for bot users) or on demand with `/fs-fix` on a PR. +* Analyze execution and discussions when a PR closes (merged or closed) or on demand with `/fs-retro` on +a PR. + +## Next steps + +Explore our documentation to see: + +* How to customize default agents. +* How to provide skills for agents. +* How to provide custom agents. +* How to run agents locally. +* How to provide your own GitHub applications.