diff options
author | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-05-09 14:49:50 +0300 |
---|---|---|
committer | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-05-09 16:15:35 +0300 |
commit | 69dcbcd981672934cbee41ab6761bca653340915 (patch) | |
tree | 4829822adf031fa0c04589a51a5876d604580815 | |
parent | fafb0b64f253c44eda91e8f44a04a0c4b0c2b6b9 (diff) |
doc: Make Protobuf-related docs more discoverable
The Protobuf-related docs are currently hosted in the `proto/` directory
due to historic reasons when `gitaly-proto` still had its own separate
repository. Let's modernize this a bit:
- `README.md` is moved into `doc/protobuf.md`.
- `CONTRIBUTING.md` is removed. We already have such a file in the
root directory.
- `DEPRECATION.md` is merged into `doc/PROCESS.md`.
This should hopefully help discoverability of this documentation.
-rw-r--r-- | doc/PROCESS.md | 17 | ||||
-rw-r--r-- | doc/protobuf.md (renamed from proto/README.md) | 0 | ||||
-rw-r--r-- | proto/CONTRIBUTING.md | 12 | ||||
-rw-r--r-- | proto/DEPRECATION.md | 16 |
4 files changed, 17 insertions, 28 deletions
diff --git a/doc/PROCESS.md b/doc/PROCESS.md index 79a78e4c5..0563af48c 100644 --- a/doc/PROCESS.md +++ b/doc/PROCESS.md @@ -519,3 +519,20 @@ if you add patches to Gitaly's Makefile, you cannot assume that installations will always have these patches. As a result, all code which makes use of patched-in features must have fallback code to support the [minimum required Git version](../README.md#installation) + +### RPC deprecation process for gitaly-proto + +First create a deprecation issue at +https://gitlab.com/gitlab-org/gitaly/issues with the title `Deprecate +RPC FooBar`. Use label `Deprecation`. Below is a template for the +issue description. + +``` +We are deprecating RPC FooBar because **REASONS**. + +- [ ] put a deprecation comment `// DEPRECATED: <ISSUE-LINK>` in ./proto **Merge Request LINK** +- [ ] find all client-side uses of RPC and list below +- [ ] update all client-side uses to no longer use RPC **ADD Merge Request LINKS** +- [ ] wait for a GitLab release in which the RPC is no longer occurring in client side code **LINK TO GITLAB-CE RELEASE TAG** +- [ ] delete the server side implementation of the old RPC in https://gitlab.com/gitlab-org/gitaly **Merge Request LINK** +``` diff --git a/proto/README.md b/doc/protobuf.md index 3fd40b5fc..3fd40b5fc 100644 --- a/proto/README.md +++ b/doc/protobuf.md diff --git a/proto/CONTRIBUTING.md b/proto/CONTRIBUTING.md deleted file mode 100644 index 442c2b00c..000000000 --- a/proto/CONTRIBUTING.md +++ /dev/null @@ -1,12 +0,0 @@ -## Developer Certificate of Origin + License - -By contributing to GitLab B.V., You accept and agree to the following terms and -conditions for Your present and future Contributions submitted to GitLab B.V. -Except for the license granted herein to GitLab B.V. and recipients of software -distributed by GitLab B.V., You reserve all right, title, and interest in and to -Your Contributions. All Contributions are subject to the following DCO + License -terms. - -[DCO + License](https://gitlab.com/gitlab-org/dco/blob/master/README.md) - -_This notice should stay as the first item in the CONTRIBUTING.md file._ diff --git a/proto/DEPRECATION.md b/proto/DEPRECATION.md deleted file mode 100644 index 18bd0b44e..000000000 --- a/proto/DEPRECATION.md +++ /dev/null @@ -1,16 +0,0 @@ -# RPC deprecation process for gitaly-proto - -First create a deprecation issue at -https://gitlab.com/gitlab-org/gitaly/issues with the title `Deprecate -RPC FooBar`. Use label `Deprecation`. Below is a template for the -issue description. - -``` -We are deprecating RPC FooBar because **REASONS**. - -- [ ] put a deprecation comment `// DEPRECATED: <ISSUE-LINK>` in ./proto **Merge Request LINK** -- [ ] find all client-side uses of RPC and list below -- [ ] update all client-side uses to no longer use RPC **ADD Merge Request LINKS** -- [ ] wait for a GitLab release in which the RPC is no longer occurring in client side code **LINK TO GITLAB-CE RELEASE TAG** -- [ ] delete the server side implementation of the old RPC in https://gitlab.com/gitlab-org/gitaly **Merge Request LINK** -``` |