mirror of
https://github.com/datahub-project/datahub.git
synced 2025-12-12 18:47:45 +00:00
doc: add page for handling deprecations, breaking changes etc. (#4590)
This commit is contained in:
parent
12f9cc2575
commit
25de224a3f
3
.github/pull_request_template.md
vendored
3
.github/pull_request_template.md
vendored
@ -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.
|
||||
- [ ] 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)
|
||||
@ -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",
|
||||
|
||||
@ -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
|
||||
|
||||
13
docs/how/updating-datahub.md
Normal file
13
docs/how/updating-datahub.md
Normal file
@ -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
|
||||
Loading…
x
Reference in New Issue
Block a user