Skip to content

docs: Remove AWS deployment and update CLI documentation#8

Merged
roncodes merged 8 commits intomainfrom
docs/remove-aws-update-cli
Feb 24, 2026
Merged

docs: Remove AWS deployment and update CLI documentation#8
roncodes merged 8 commits intomainfrom
docs/remove-aws-update-cli

Conversation

@roncodes
Copy link
Member

Summary

This PR removes all AWS-specific deployment content and updates the documentation to focus on CLI-based installation as the primary method.

Changes Made

Priority 1: Critical Changes

  • Deleted docs/deploying/deploy-to-aws.md (188 lines of AWS-specific content)
  • Created docs/getting-started/install/install-with-cli.md - New primary installation guide
  • Updated docs/introduction.md - Removed AWS section, added CLI quick start
  • Rewrote docs/quick-start.md - Complete rewrite focusing on CLI installation
  • Expanded docs/extensions/fleetbase-cli.md - Added all new commands and developer account guides

Priority 2: Important Changes

  • Updated docs/deploying/deploy-cloud.md - Removed AWS section, reordered providers (DigitalOcean first)
  • Updated docs/deploying/deploy-on-premise.md - Added CLI as recommended method

Priority 3: Cleanup

  • ✅ Removed AWS SES references (6 files) - replaced with generic email providers
  • ✅ Updated sidebar positions (CLI installation now first)
  • ✅ Removed AWS reference in admin guide

New Features

CLI Installation Guide

  • Step-by-step installation instructions
  • Troubleshooting section
  • Comparison with other installation methods
  • Post-installation configuration guide

Developer Account Documentation

  • Complete registration workflow
  • Email verification process
  • Token generation and management
  • Self-hosted vs Cloud comparison

Updated Commands

  • flb install-fleetbase - Install Fleetbase with Docker
  • flb register - Register developer account
  • flb verify - Verify email address
  • flb resend-verification - Resend verification code
  • flb generate-token - Generate/regenerate registry token
  • flb set-auth - Set registry authentication token

Impact

  • Files Changed: 12 (1 deleted, 1 created, 10 updated)
  • Lines Changed: ~800-1000 lines
  • AWS References Removed: 37 occurrences
  • New Content Added: ~500 lines

Testing

  • All internal links verified
  • No broken links to AWS deployment page
  • Sidebar navigation shows correct order
  • CLI installation is prominently featured
  • Code examples are correct

Related Issues

Closes #[issue-number] (if applicable)


Note: This PR makes CLI-based installation the default and recommended method for all users, while maintaining manual Docker and source installation options for advanced users.

Comment on lines +9 to +21
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Publish GitHub Release
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ github.ref_name }}
name: ${{ github.ref_name }}
generate_release_notes: true
draft: false
prerelease: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} No newline at end of file

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}

Copilot Autofix

AI 3 days ago

In general, the fix is to explicitly declare a permissions block, either at the workflow root (applies to all jobs) or at the individual job level, granting only the minimum scopes required. For a release-creation workflow using softprops/action-gh-release, the job needs to write releases (and typically contents), so we should grant contents: write (and optionally a narrower contents: write without other write scopes). We do not need broad write access to issues, pull requests, etc., so we should avoid those unless the workflow actually uses them.

The best targeted fix here is to add a permissions block under the create job (right below runs-on: ubuntu-latest) specifying minimal necessary scopes. According to GitHub’s permission model, to create a release we need contents: write. We can therefore add:

    permissions:
      contents: write

immediately under runs-on: ubuntu-latest. This keeps existing functionality intact while constraining GITHUB_TOKEN to only what the job requires. No additional imports or libraries are involved, since this is just a YAML workflow configuration change within .github/workflows/create-release.yml.

Suggested changeset 1
.github/workflows/create-release.yml

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml
--- a/.github/workflows/create-release.yml
+++ b/.github/workflows/create-release.yml
@@ -7,6 +7,8 @@
 jobs:
   create:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
         - uses: actions/checkout@v4
         - name: Publish GitHub Release
EOF
@@ -7,6 +7,8 @@
jobs:
create:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Publish GitHub Release
Copilot is powered by AI and may make mistakes. Always verify output.
@roncodes roncodes merged commit e62d62d into main Feb 24, 2026
5 checks passed
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.

1 participant