yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-12-13 19:17:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: add page for handling deprecations, breaking changes etc. (#4590)

Browse Source
This commit is contained in:
Aseem Bansal 2022-04-07 22:18:47 +05:30 committed by GitHub
parent 12f9cc2575
commit 25de224a3f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/pull_request_template.md vendored
View File

@ -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)) - [ ] 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) - [ ] Links to related issues (if applicable)
- [ ] Tests for the changes have been added/updated (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)

1
docs-website/sidebars.js
View File

@ -211,6 +211,7 @@ module.exports = {
"docs/developers", "docs/developers",
"docs/docker/development", "docs/docker/development",
"docs/how/backup-datahub", "docs/how/backup-datahub",
"docs/how/updating-datahub",
{ {
type: "doc", type: "doc",
label: "Ingesting files from S3", label: "Ingesting files from S3",

1
docs/CONTRIBUTING.md
View File

@ -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. * 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). * 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! * That's it! Thank you for your contribution!
## Commit Message Format ## Commit Message Format

13
docs/how/updating-datahub.md Normal file
View 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