* Updated the Writing documentation section in CONTRIBUTING.md * More changes
This commit is contained in:
parent
bc7276a3ee
commit
4984bc6bbe
|
@ -632,18 +632,23 @@ To build the docs, you must clone the [elastic/docs](https://github.com/elastic/
|
|||
repo as a sibling of your kibana repo. Follow the instructions in that project's
|
||||
README for getting the docs tooling set up.
|
||||
|
||||
**To build the docs and open them in your browser:**
|
||||
**To build the Kibana docs and open them in your browser:**
|
||||
|
||||
```bash
|
||||
./docs/build_docs --doc kibana/docs/index.asciidoc --chunk 1 --open
|
||||
```
|
||||
or
|
||||
|
||||
```bash
|
||||
node scripts/docs.js --open
|
||||
```
|
||||
|
||||
### Release Notes Process
|
||||
### Release Notes process
|
||||
|
||||
Part of this process only applies to maintainers, since it requires access to GitHub labels.
|
||||
|
||||
Kibana publishes major, minor and patch releases periodically through the year. During this process we run a script against this repo to collect the applicable PRs against that release and generate [Release Notes](https://www.elastic.co/guide/en/kibana/current/release-notes.html).
|
||||
To include your change in the Release Notes:
|
||||
Kibana publishes [Release Notes](https://www.elastic.co/guide/en/kibana/current/release-notes.html) for major and minor releases. To generate the Release Notes, the writers run a script against this repo to collect the merged PRs against the release.
|
||||
To include your PRs in the Release Notes:
|
||||
|
||||
1. In the title, summarize what the PR accomplishes in language that is meaningful to the user. In general, use present tense (for example, Adds, Fixes) in sentence case.
|
||||
2. Label the PR with the targeted version (ex: `v7.3.0`).
|
||||
|
@ -652,9 +657,9 @@ To include your change in the Release Notes:
|
|||
* For an external-facing fix, use `release_note:fix`. Exception: docs, build, and test fixes do not go in the Release Notes. Neither fixes for issues that were only on `master` and never have been released.
|
||||
* For a deprecated feature, use `release_note:deprecation`.
|
||||
* For a breaking change, use `release_note:breaking`.
|
||||
* To **NOT** include your changes in the Release Notes, please use `release_note:skip`.
|
||||
* To **NOT** include your changes in the Release Notes, use `release_note:skip`.
|
||||
|
||||
We also produce a blog post that details more important breaking API changes every minor and major release. If the PR includes a breaking API change, apply the label `release_note:dev_docs`. Additionally add a brief summary of the break at the bottom of the PR using the format below:
|
||||
We also produce a blog post that details more important breaking API changes in every major and minor release. When your PR includes a breaking API change, add the `release_note:dev_docs` label, and add a brief summary of the break at the bottom of the PR using the format below:
|
||||
|
||||
```
|
||||
# Dev Docs
|
||||
|
|
Loading…
Reference in a new issue