Et/migrate packer #1232
Draft
Et/migrate packer #1232
Conversation
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
Successfully integrated Packer website content into the web-unified-docs platform with full functionality. ## What's Working - **Docker Setup**: Both unified-docs-api and dev-portal containers running successfully - **Content Migration**: All Packer docs, examples, data, and assets properly migrated - **Web Interface**: Packer documentation accessible at http://localhost:3000/packer - **API Integration**: Redirects API working correctly (/api/content/packer/redirects) - **Product Support**: Packer listed as supported product in unified-docs system ## Key Issues Resolved - **Unversioned Documentation**: Configured `versionedDocs: false` for Packer in productConfig.mjs (unlike other products that use versioned structures) - **Content Structure**: Fixed nested directory issues (docs/docs) to match expected unified-docs format - **Redirects Format**: Converted Packer redirects from JS format to JSONC format required by unified-docs - **Port Conflicts**: Resolved Docker port binding conflicts during development - **Directory Structure**: Ensured proper content/packer/docs/ hierarchy vs versioned content/product/vX.X.X/ pattern ## Migration Summary Packer now fully integrated into unified-docs with proper unversioned documentation structure. The system handles Packer's non-versioned content correctly while maintaining compatibility with other versioned products in the platform.
These compiled binaries should not be in version control and should be generated during build processes instead.
Updates the documentation content directory from 'docs' to 'content'. This change aligns the documentation structure with the new site generation process, ensuring proper content loading and rendering.
Contributor
Vercel Previews Deployed
|
Younique98
force-pushed
the
et/migrate-packer
branch
from
d40dd89 to
389bab7
Compare
Contributor
Broken Link CheckerNo broken links found! 🎉 |
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.
🔗 Relevant links
Preview link 🔎
Asana task 🎟️
🗒️ What
🤷 Why
The Packer documentation needed to be migrated from its standalone website to the unified documentation system to:
🛠️ How
Content Migration
Copied all relevant files from Packer repository (content, data, public, examples, etc.)
Analyzed existing product structures to understand the required layout for versionedDocs: false products
Discovered that non-versioned products require nested content/ structure: content/packer/content/docs/ instead of content/packer/docs/
Configuration Updates
Added Packer configuration to productConfig.mjs with versionedDocs: false
Enhanced the unified-docs Makefile with Packer development targets (packer-dev, packer-website-dev)
Converted Packer redirects from JavaScript to JSONC format to match unified-docs expectations
Structure Fixes
Compared with working non-versioned products (HCP docs, well-architected-framework)
Implemented nested structure (content/packer/content/docs/) and moved partials accordingly
Fixed MDX include path resolution issues by placing partials at content
Docker & Build
Resolved Docker build issues related to missing binary files in prebuild scripts
Successfully integrated Packer content processing into the unified-docs build pipeline
Verified all routes work correctly after structural changes
📸 Design Screenshots
No design changes - this is an infrastructure/content migration maintaining existing Packer documentation appearance and functionality.
🧪 Testing
Verify Docker containers start successfully: docker compose --profile unified-docs up -d
Test main Packer page: http://localhost:3000/packer
Test docs landing page: http://localhost:3000/packer/docs (primary fix)
Test install page: http://localhost:3000/packer/install
Test tutorials page: http://localhost:3000/packer/tutorials
Test integrations page: http://localhost:3000/packer/integrations
Verify Makefile targets work: make packer-dev and make unified-docs
Check that redirects are properly loaded (inspect network requests)
Verify content includes/partials render correctly (no broken @include references)
💭 Anything else?
Future Considerations
Revert Plan
review checklist
I have documented a clear reason for, and description of, the change I am making.
If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
If applicable, I've documented the impact of any changes to security controls.