Skip to content

Commit

Permalink
Move to the migration guide at Buf docs (#294)
Browse files Browse the repository at this point in the history
**This PR should not be merged until Buf docs are updated to contain the
`protoc-gen-validate` migration guide.**

This PR:

1. Changes internal links to the migration guide to point to the new URL
that lives under buf.build/docs
2. Drops the migration guide from this repository.

This PR does not:

1. Fix the invalid link in the migration guide referring to legacy mode:
that's part of the new guide at buf.build/docs.
  • Loading branch information
jrinehart-buf authored Jan 22, 2025
1 parent 29ae204 commit 24c9cf4
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 169 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ Offered under the [Apache 2 license][license].
[file-bug]: https://github.com/bufbuild/protovalidate/issues/new?assignees=&labels=Bug&template=bug_report.md&title=%5BBUG%5D
[file-feature-request]: https://github.com/bufbuild/protovalidate/issues/new?assignees=&labels=Feature&template=feature_request.md&title=%5BFeature+Request%5D
[license]: https://github.com/bufbuild/protovalidate/blob/main/LICENSE
[migrate]: https://github.com/bufbuild/protovalidate/blob/main/docs/migrate.md
[migrate]: https://buf.build/docs/migration-guides/migrate-from-protoc-gen-validate/
[migration-tool]: https://github.com/bufbuild/protovalidate/blob/main/tools/protovalidate-migrate
[pgv]: https://github.com/bufbuild/protoc-gen-validate
[pv-go]: https://github.com/bufbuild/protovalidate-go
Expand Down
4 changes: 3 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ existing projects to `protovalidate`.
Conformance tool. Learn how to use this tool to ensure all implementations
align with `protovalidate`'s rules and constraints effectively.

- [Migrate](migrate.md): If you're planning to migrate your existing project to
- [Migrate][migrate]: If you're planning to migrate your existing project to
`protovalidate`, this guide is for you. The Migrate tool is designed to help
you transition smoothly, minimizing any potential disruption to your project's
development.

[migrate]: https://buf.build/docs/migration-guides/migrate-from-protoc-gen-validate/
166 changes: 0 additions & 166 deletions docs/migrate.md

This file was deleted.

1 change: 0 additions & 1 deletion tools/protovalidate-migrate/README.md

This file was deleted.

10 changes: 10 additions & 0 deletions tools/protovalidate-migrate/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
![The Buf logo](https://raw.githubusercontent.com/bufbuild/protovalidate/main/.github/buf-logo.svg)

# Migrating from `protoc-gen-validate`

Migrating from `protoc-gen-validate` to `protovalidate` should be safe, incremental, and relatively painless.

Visit [Buf's documentation][migrate] to learn about automated and manual migrations.

[migrate]: https://buf.build/docs/migration-guides/migrate-from-protoc-gen-validate/

0 comments on commit 24c9cf4

Please sign in to comment.