diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 01d9eb6189..1c80fb20a3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,4 +4,5 @@ - [ ] The PR conforms to DataHub's [Contributing Guideline](https://github.com/datahub-project/datahub/blob/master/docs/CONTRIBUTING.md) (particularly [Commit Message Format](https://github.com/datahub-project/datahub/blob/master/docs/CONTRIBUTING.md#commit-message-format)) - [ ] Links to related issues (if applicable) - [ ] Tests for the changes have been added/updated (if applicable) -- [ ] Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same. \ No newline at end of file +- [ ] Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same. +- [ ] For any breaking change/potential downtime/deprecation/big changes an entry has been made in [Updating DataHub](https://github.com/datahub-project/datahub/blob/master/docs/how/updating-datahub.md) \ No newline at end of file diff --git a/docs-website/sidebars.js b/docs-website/sidebars.js index dc2570d8e5..e8cc731fd1 100644 --- a/docs-website/sidebars.js +++ b/docs-website/sidebars.js @@ -211,6 +211,7 @@ module.exports = { "docs/developers", "docs/docker/development", "docs/how/backup-datahub", + "docs/how/updating-datahub", { type: "doc", label: "Ingesting files from S3", diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 87c645c536..b861721779 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -30,6 +30,7 @@ Before you submit your Pull Request (PR), consider the following guidelines: * Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort. * Follow the [standard GitHub approach](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to create the PR. Please also follow our [commit message format](#commit-message-format). +* If there are any breaking changes, potential downtime, deprecations, or big feature please add an update in [Updating DataHub under Next](how/updating-datahub.md). * That's it! Thank you for your contribution! ## Commit Message Format diff --git a/docs/how/updating-datahub.md b/docs/how/updating-datahub.md new file mode 100644 index 0000000000..f25a11f834 --- /dev/null +++ b/docs/how/updating-datahub.md @@ -0,0 +1,13 @@ +# Updating DataHub + +This file documents any backwards-incompatible changes in DataHub and assists people when migrating to a new version. + +## Next + +### Breaking Changes + +### Potential Downtime + +### Deprecations + +### Other notable Changes