Skip to content

Conversation

@Younique98
Copy link
Contributor

πŸ”— Relevant links

Preview link πŸ”Ž
Asana task 🎟️

πŸ—’οΈ What

  • Migrated Packer documentation and website content into the web-unified-docs system
  • Enhanced unified-docs Makefile with Packer-specific development targets
  • Fixed content structure to support non-versioned products (versionedDocs: false)
  • Integrated Packer routes: packer, /packer/docs, /packer/install, /packer/tutorials, /packer/integrations
  • Converted and restored Packer redirects from JS to JSONC format
  • Set up proper Docker configuration for Packer content

🀷 Why

The Packer documentation needed to be migrated from its standalone website to the unified documentation system to:

  • Consolidate HashiCorp documentation under a single platform
  • Improve maintenance and development workflow
  • Provide consistent user experience across HashiCorp products
  • Enable shared infrastructure and tooling benefits

πŸ› οΈ 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

  • The Packer productConfig includes a TODO about plugin documentation that may need attention
  • May need to monitor for any missing content or broken links during initial deployment
  • Consider adding automated tests for critical Packer routes

Revert Plan

  • If issues arise, the migration can be reverted
  • Removing Packer configuration from productConfig.mjs
  • Removing Packer content directory: content/packer/
  • Reverting Makefile changes
  • Removing Packer-related Docker compose modifications

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.

LeahMarieBush and others added 25 commits July 9, 2025 10:23
* chore: add vault versions v1.4.x through v1.6.x to develop

* fix nav data files for v1.4.x - v1.7.x

* add missing partials and fix older versions

* add the rest of missing partials
Updated the module test/ enable testing doc
…egistry/ Enable testing - doc improvment (#1197)

Updated the module test/ enable testing doc

Please go to the `Preview` tab and select the appropriate template:

* [HCP services](?expand=1&template=hcp_pull_request_template.md)
* [Terraform
Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)

[Jira ticket](https://hashicorp.atlassian.net/browse/IPL-8749)
* Add tool files

* Small updates and add headers

* Fix header (again)

* remove tf test data and push final tool updates
Corrects a condition where versionless documents could cause errors during partial resolution.

Adds a prebuilt binary for ARM-based macOS.
Removes an unnecessary comment from the function.
The comment restated the function's obvious return value.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants