docs(#1290): add export blocks for shell variables in install guide#1295
Merged
Conversation
Each section of the installation guide now begins with an explicit export block listing all required shell variables for that section. Previously, variables like $ORG_NAME and $GCP_PROJECT were referenced in code blocks without being defined, forcing administrators to scan each section to discover what needed to be set before running commands. The Advanced: pre-configure WIF section already followed this pattern — this change brings all other sections in line. Sections updated: - Section 1 (Run the installer): ORG_NAME, GCP_PROJECT - Multi-org first org: FIRST_ORG, GCP_PROJECT - Multi-org additional orgs: ADDITIONAL_ORG - Enable/disable repos: ORG_NAME - Analyze: ORG_NAME - Uninstall: ORG_NAME - Per-repo first-time: ORG_NAME, REPO_NAME, GCP_PROJECT - Per-repo reusing infrastructure: MINT_URL - Custom app sets: ORG_NAME, GCP_PROJECT, NEW_ORG Where variables carry over from a prior step in the same workflow, a note says so instead of repeating the export. Note: make lint could not run due to a sandbox infrastructure issue (Go toolchain permission denied). This is a docs-only change with no Go code modifications. Closes #1290
Site previewPreview: https://d26b447d-site.fullsend-ai.workers.dev Commit: |
ReviewFindingsNo findings. |
![fullsend-ai-review[bot]](https://avatars.githubusercontent.com/in/3478501?s=60&v=4){kind=small}
fullsend-ai-review
Bot
added
the
ready-for-merge
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Each section of the installation guide now begins with an explicit export block listing all required shell variables for that section. Previously, variables like $ORG_NAME and $GCP_PROJECT were referenced in code blocks without being defined, forcing administrators to scan each section to discover what needed to be set before running commands. The Advanced: pre-configure WIF section already followed this pattern — this change brings all other sections in line.
Sections updated:
Where variables carry over from a prior step in the same workflow, a note says so instead of repeating the export.
Note: make lint could not run due to a sandbox infrastructure issue (Go toolchain permission denied). This is a docs-only change with no Go code modifications.
Closes #1290
Post-script verification
agent/1290-consistent-install-vars)f432d152647ddc9195667abbfd27f78059b199c8..HEAD)