Skip to content

Conversation

@LeahMarieBush
Copy link
Contributor

@LeahMarieBush LeahMarieBush commented Jul 8, 2025

Description

This PR migrates the rest of the vault docs to the develop branch of UDR. Most of this is just from the migration script but there are a few other changes I had to make:

  • Update nav-data files for v1.4.x through v1.7.x to be the correct format. In these previous versions, the files were named incorrectly and were not in json format. I renamed and formatted them correctly so they will work like the newer versions
  • Update partials paths for v1.4.x through v1.6.x. In these previous versions, the path used to be @inlcude partials/file_name.mdx. I updated them to just be @include file_name.mdx like the other versions so our api could find the files
  • Add partials/telemetry-metrics/vault/cache partial files. Our .gitignore file was ignoring files that had the folder cache. I removed that line from the gitignore and also added the files back in.

Testing

Since all vault files are included in this branch, some testing would be good. I've done a bit but it would be good if someone else could double check too.

  1. Checkout this branch
  2. Run npm run prebuild
  3. Run npm run dev
  4. In dev-portal, add vault to the unified_docs_migrated_repos flag in the config/unified-docs-sandbox.json file.
  5. In dev-portal, change UNIFIED_DOCS_API to be http://localhost:8080 in the .env file
  6. In dev-portal, run HASHI_ENV=unified-docs-sandbox npm start
  7. Go to http://localhost:3000 and checkout a few of the vault docs from different versions to verify you aren't seeing any issues with images, partials, and just general docs

@github-actions
Copy link
Contributor

github-actions bot commented Jul 8, 2025

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Tue Jul 8 19:33:56 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Tue Jul 8 19:25:23 UTC 2025

@github-actions
Copy link
Contributor

github-actions bot commented Jul 8, 2025

Broken Link Checker

Report exceeds max length of 65536 characters, so it cannot be displayed in GitHub comments. Download full report.

@LeahMarieBush LeahMarieBush marked this pull request as ready for review July 8, 2025 19:59
@LeahMarieBush LeahMarieBush requested a review from a team as a code owner July 8, 2025 19:59
Copy link
Contributor

@RubenSandwich RubenSandwich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@LeahMarieBush LeahMarieBush merged commit bf2f14b into develop Jul 9, 2025
8 of 9 checks passed
@LeahMarieBush LeahMarieBush deleted the leah/chore/vault-migrate-part-4 branch August 5, 2025 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants