Add GitHub Pages deployment for docs.wolfssl.com#267
Open
MarkAtwood wants to merge 2 commits into
Open
Conversation
Author
|
Update: This PR is ready for technical review and awaiting business approval from Larry and Todd. Pitch email drafted at Quick summary for reviewers:
See DEPLOYMENT-PREP.md for complete deployment checklist and cost analysis. |
Set up automatic deployment of all wolfSSL documentation to docs.wolfssl.com: - GitHub Actions workflow builds all 18+ manuals on push to master - Organized site structure: each manual in its own subdirectory - Landing page with cards for all products (core, additional, wrappers, guides) - Both HTML and PDF available for each manual - Custom domain configured (docs.wolfssl.com) - Automatic deployment via GitHub Pages Advantages over WordPress VM: - Zero hosting cost (was part of $50-100/month VM) - Automatic deployment (was manual FTP) - Version controlled (git tracks all changes) - CI/CD pipeline (test builds on every PR) - More secure (static files, no server to compromise) - Faster (CDN edge caching vs single VM) - Better developer experience (git workflow vs FTP) Build time: ~15-20 minutes for all manuals DNS setup required: Point docs.wolfssl.com A records to GitHub Pages IPs Created comprehensive setup guide in GITHUB-PAGES-SETUP.md covering: - Architecture and site structure - DNS configuration - Adding new manuals - Local testing - Comparison to WordPress VM - Migration plan - Troubleshooting
Comprehensive pre-deployment documentation covering: - Technical prerequisites (all complete) - Step-by-step deployment checklist - Timeline (1 hour active work + 20 min automated) - 30-day validation period plan - Rollback procedures (5 minutes to revert) - Risk assessment (low risk across the board) - Cost analysis ($590/year savings, 96% reduction) - Benefits summary for all stakeholders - Success criteria and rollback triggers - Q&A section - Communication plan Makes business case clear: faster, cheaper, more secure, automatic. Ready for executive approval to proceed with migration.
MarkAtwood
force-pushed
the
github-pages-deployment
branch
from
a4a1567 to
bcc450d
Compare
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
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.
Summary
Adds automatic GitHub Pages deployment for all wolfSSL documentation to
docs.wolfssl.com.⏳ Status: Waiting for approval from Larry and Todd
Changes
How It Works
Key Benefits
vs. WordPress VM deployment:
Cost Savings
Next Steps After Approval
docs.wolfssl.comRisk & Rollback
Risk level: LOW
Validation period: 30 days with both sites running before removing docs from WordPress VM
Documentation
Full details in deployment prep doc. Total deployment time: ~1 hour active work + 20 min automated build.
📧 Pitch email drafted for Larry/Todd
🤖 Ready to decommission docs from WordPress VM after DNS cutover