Add migration guides from dotenv-vault, sops, and git-crypt#34
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Adds a new “Migration Guides” docs page to help users move from competing secret-management tools to xenvsync, and wires it into the docs navigation and on-site search.
Changes:
- Add a new
/docs/migrationpage with guides for dotenv-vault, sops, and git-crypt plus a feature comparison table. - Add the migration page to the docs sidebar navigation.
- Extend the client-side search index with migration-related entries/anchors.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
website/src/components/Sidebar.tsx |
Adds “Migration Guides” to the docs sidebar under “Learn”. |
website/src/components/Search.tsx |
Adds search index entries for migration anchors (dotenv-vault, sops, git-crypt, comparison). |
website/src/app/docs/migration/page.tsx |
New migration guides page content and metadata. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <h3 className="text-base font-medium mt-6 mb-2">3. Clean up dotenv-vault</h3> | ||
| <CodeBlock language="bash"> | ||
| {`# Remove dotenv-vault artifacts | ||
| rm -f .env.vault # (the old dotenv-vault format, now replaced by xenvsync's) | ||
| rm -f .env.keys | ||
|
|
||
| # Remove dotenv-vault from dependencies | ||
| npm uninstall dotenv-vault | ||
|
|
||
| # Commit the new vault | ||
| git add .env.vault .gitignore | ||
| git commit -m "Migrate from dotenv-vault to xenvsync"`} |
There was a problem hiding this comment.
In the dotenv-vault migration steps, the cleanup block deletes .env.vault (rm -f .env.vault) but the very next commands ask users to git add .env.vault. Since xenvsync push also produces .env.vault, this instruction would remove the newly created xenvsync vault and make the later steps fail. Consider removing this rm line, or moving it before xenvsync push with clearer wording about deleting the dotenv-vault vault before generating the xenvsync vault.
- Add docs page with step-by-step migration guides for each tool - Include feature comparison table - Add migration page to sidebar navigation - Update search index with migration content Closes #18
nasimstg
force-pushed
the
feat/migration-guides
branch
from
eefe346 to
2162db1
Compare
Summary
Test plan
Closes #18