Skip to content

Commit 835964b

Browse files
authored
Updated the Writing documentation section in CONTRIBUTING.md (#68434)
* Updated the Writing documentation section in CONTRIBUTING.md * More changes
1 parent 4a38772 commit 835964b

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -661,18 +661,23 @@ To build the docs, you must clone the [elastic/docs](https://github.com/elastic/
661661
repo as a sibling of your kibana repo. Follow the instructions in that project's
662662
README for getting the docs tooling set up.
663663

664-
**To build the docs and open them in your browser:**
664+
**To build the Kibana docs and open them in your browser:**
665+
666+
```bash
667+
./docs/build_docs --doc kibana/docs/index.asciidoc --chunk 1 --open
668+
```
669+
or
665670

666671
```bash
667672
node scripts/docs.js --open
668673
```
669674

670-
### Release Notes Process
675+
### Release Notes process
671676

672677
Part of this process only applies to maintainers, since it requires access to GitHub labels.
673678

674-
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).
675-
To include your change in the Release Notes:
679+
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.
680+
To include your PRs in the Release Notes:
676681

677682
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.
678683
2. Label the PR with the targeted version (ex: `v7.3.0`).
@@ -681,9 +686,9 @@ To include your change in the Release Notes:
681686
* 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.
682687
* For a deprecated feature, use `release_note:deprecation`.
683688
* For a breaking change, use `release_note:breaking`.
684-
* To **NOT** include your changes in the Release Notes, please use `release_note:skip`.
689+
* To **NOT** include your changes in the Release Notes, use `release_note:skip`.
685690

686-
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:
691+
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:
687692

688693
```
689694
# Dev Docs

0 commit comments

Comments
 (0)