feat: Migrate documentation from GitHub Pages to Netlify#87
Closed
feat: Migrate documentation from GitHub Pages to Netlify#87
Conversation
- Replace GitHub Pages deployment with a new Netlify workflow. - Add netlify.toml for build configuration and redirects. - Update mkdocs.yml with the new Netlify site URL. - Rebuild the site to reflect the new URLs. Resolves #86
Documents all changes made, next steps required, and benefits achieved for the GitHub Pages to Netlify migration (issue #86).
❌ Deploy Preview for structio failed.
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #87 +/- ##
=======================================
Coverage ? 67.94%
=======================================
Files ? 26
Lines ? 1719
Branches ? 223
=======================================
Hits ? 1168
Misses ? 497
Partials ? 54 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
🚀 Overview
This PR implements issue #86 by migrating the project documentation hosting from GitHub Pages to Netlify, providing improved deployment flexibility and advanced hosting features.
✨ Key Changes
1. Deployment Infrastructure
.github/workflows/deploy-netlify.ymlusingnwtgck/actions-netlify@v3.0netlify.tomlwith build configuration and redirects.github/workflows/deploy-pages.yml2. URL Migration
mkdocs.ymlsite URL:https://httpdss.github.io/struct/→https://structio.netlify.app/site/docstosite3. Enhanced Features
🔧 Technical Details
New Netlify Workflow Features:
mainand pull requestsmkdocs buildcommand./sitedirectoryNETLIFY_AUTH_TOKENandNETLIFY_SITE_IDsecretsNetlify Configuration:
mkdocs buildsite📋 Post-Merge Requirements
Repository Secrets Setup
The following secrets must be configured in the repository:
NETLIFY_AUTH_TOKEN- Generate from Netlify → User settings → Personal access tokensNETLIFY_SITE_ID- Found in Netlify site settings → Site informationNetlify Site Configuration
structio.netlify.app🧪 Testing
mkdocs build📚 Documentation
Included
NETLIFY_MIGRATION_SUMMARY.mdwith:🌟 Benefits
🔗 Related
Closes #86
Ready for review! 🎉 This PR fully implements the Netlify migration as specified in the issue requirements.