docs: Improve Linux installation documentation #1094
+24
−6
Conversation
This file contains 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
- Add cli.png to docs/assets for GitHub Pages favicon - Update book.toml with GitHub Pages configuration - Complete Linux installation instructions for Ubuntu/Debian and AppImage 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
- Comment out fork restrictions to enable testing on forked repos - This change allows testing the GitHub Pages deployment before merging 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
- Configure workflow to run on pushes to docs/fix-github-pages branch - This allows testing the GitHub Pages deployment directly from the feature branch 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
- Replace verbose onboarding steps with simple 'q login' command - Improve clarity and conciseness of getting started section - Maintain all installation instructions and support information 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
- Remove the cli.png file that was causing issues with GitHub Pages - This file will need to be provided by maintainers with proper branding 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
- Comment out the favicon configuration in book.toml - This prevents GitHub Pages build errors due to missing image - Maintainers can uncomment and provide proper image later 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
- Remove book.toml to test if GitHub Pages still deploys without it - This is an experimental change to understand the deployment process 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
- Restore the original book.toml from the main branch - Remove only the favicon configuration that was causing issues - This keeps the essential mdBook configuration intact 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
docs: Restore original book.toml without favicon config
- Restore the original workflow configuration from the upstream repository - Remove custom branch triggers that were added for testing - Re-enable the fork check to prevent deployment from forks 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
ci: Reset GitHub Pages workflow to match upstream
Replace Ubuntu/Debian and AppImage installation methods with direct download instructions for x86-64 and ARM architectures to simplify the installation process. 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1094 +/- ##
==========================================
- Coverage 13.84% 13.69% -0.16%
==========================================
Files 2371 2361 -10
Lines 205096 203706 -1390
Branches 185460 184070 -1390
==========================================
- Hits 28398 27890 -508
+ Misses 175267 174427 -840
+ Partials 1431 1389 -42 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
brandonskiser
requested changes
Apr 8, 2025
|
Thanks for the contribution! Just a couple changes |
Address PR feedback by: - Using install.sh script instead of manually moving binary - Restoring the Builder ID vs IAM Identity Center note as a block quote 🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR enhances the Linux installation documentation by:
These changes help Linux users better integrate Amazon Q into their workflow and desktop environments.
I acknowledge that by submitting this pull request, I am contributing code to an AWS open source project and agree to the terms of the project's licensing.
🤖 Assisted by Amazon Q Developer