-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs] Add a release notes template (#15333)
* Add release notes template * Update spellcheck
- Loading branch information
Showing
4 changed files
with
763 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
--- | ||
id: release-notes | ||
title: "Release notes" | ||
--- | ||
|
||
<!-- | ||
~ Licensed to the Apache Software Foundation (ASF) under one | ||
~ or more contributor license agreements. See the NOTICE file | ||
~ distributed with this work for additional information | ||
~ regarding copyright ownership. The ASF licenses this file | ||
~ to you under the Apache License, Version 2.0 (the | ||
~ "License"); you may not use this file except in compliance | ||
~ with the License. You may obtain a copy of the License at | ||
~ | ||
~ http://www.apache.org/licenses/LICENSE-2.0 | ||
~ | ||
~ Unless required by applicable law or agreed to in writing, | ||
~ software distributed under the License is distributed on an | ||
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
~ KIND, either express or implied. See the License for the | ||
~ specific language governing permissions and limitations | ||
~ under the License. | ||
--> | ||
|
||
<!--Replace {{DRUIDVERSION}} with the correct Druid version.--> | ||
|
||
Apache Druid {{DRUIDVERSION}} contains over $NUMBER_FEATURES new features, bug fixes, performance enhancements, documentation improvements, and additional test coverage from $NUMBER_OF_CONTRIBUTORS contributors. | ||
|
||
<!-- | ||
Replace {{MILESTONE}} with the correct milestone number. For example: https://github.com/apache/druid/issues?q=is%3Aclosed+milestone%3A28.0+sort%3Aupdated-desc+ | ||
--> | ||
|
||
See the [complete set of changes](https://github.com/apache/druid/issues?q=is%3Aclosed+milestone%3A{{MILESTONE}}+sort%3Aupdated-desc+) for additional details, including bug fixes. | ||
|
||
Review the [upgrade notes](#upgrade-notes) and [incompatible changes](#incompatible-changes) before you upgrade to Druid {{DRUIDVERSION}}. | ||
If you are upgrading across multiple versions, see the [Upgrade notes](upgrade-notes.md) page, which lists upgrade notes for the most recent Druid versions. | ||
|
||
<!-- | ||
This file is a collaborative work in process. Adding a release note to this file doesn't guarantee its presence in the next release until the release branch is cut and the release notes are finalized. | ||
This file contains the following sections: | ||
- Important features, changes, and deprecations | ||
- Functional area and related changes | ||
- Upgrade notes and incompatible changes | ||
Please add your release note to the appropriate section and include the following: | ||
- Detailed title | ||
- Summary of the changes (a couple of sentences) aimed at Druid users | ||
- Link to the associated PR | ||
If your release note contains images, put the images in the release-info/assets folder. | ||
For tips about how to write a good release note, see [Release notes](https://github.com/apache/druid/blob/master/CONTRIBUTING.md#release-notes). | ||
--> | ||
|
||
## Important features, changes, and deprecations | ||
|
||
This section contains important information about new and existing features. | ||
|
||
## Functional area and related changes | ||
|
||
This section contains detailed release notes separated by areas. | ||
|
||
### Web console | ||
|
||
#### Other web console improvements | ||
|
||
### Ingestion | ||
|
||
#### SQL-based ingestion | ||
|
||
##### Other SQL-based ingestion improvements | ||
|
||
#### Streaming ingestion | ||
|
||
##### Other streaming ingestion improvements | ||
|
||
### Querying | ||
|
||
#### Other querying improvements | ||
|
||
### Cluster management | ||
|
||
#### Other cluster management improvements | ||
|
||
### Data management | ||
|
||
#### Other data management improvements | ||
|
||
### Metrics and monitoring | ||
|
||
### Extensions | ||
|
||
### Documentation improvements | ||
|
||
## Upgrade notes and incompatible changes | ||
|
||
### Upgrade notes | ||
|
||
### Incompatible changes | ||
|
||
### Developer notes | ||
|
||
#### Dependency updates | ||
|
||
The following dependencies have had their versions bumped: |
Oops, something went wrong.