github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[7.x] Minor developer guide doc changes (#75763) (#76198)

Browse source
This commit is contained in:
Nathan L Smith 2020-08-30 20:54:06 -05:00 • committed by GitHub
parent 5a08b86087
commit ee7c07194f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/developer/best-practices/index.asciidoc
View file

@ -48,7 +48,7 @@ guidelines]
* Write all new code on
{kib-repo}blob/{branch}/src/core/README.md[the
platform], and following
{kib-repo}blob/{branch}/src/core/CONVENTIONS.md[conventions]
{kib-repo}blob/{branch}/src/core/CONVENTIONS.md[conventions].
* _Always_ use the `SavedObjectClient` for reading and writing Saved
Objects.
* Add `README`s to all your plugins and services.

10
docs/developer/best-practices/stability.asciidoc
View file

@ -52,15 +52,15 @@ storeinSessions?)
[discrete]
=== Browser coverage
Refer to the list of browsers and OS {kib} supports
Refer to the list of browsers and OS {kib} supports:
https://www.elastic.co/support/matrix
Does the feature work efficiently on the list of supported browsers?
[discrete]
=== Upgrade Scenarios - Migration scenarios-
=== Upgrade and Migration scenarios
Does the feature affect old
indices, saved objects ? - Has the feature been tested with {kib}
aliases - Read/Write privileges of the indices before and after the
* Does the feature affect old indices or saved objects?
* Has the feature been tested with {kib} aliases?
* Read/Write privileges of the indices before and after the
upgrade?

4
docs/developer/getting-started/building-kibana.asciidoc
View file

@ -1,7 +1,7 @@
[[building-kibana]]
== Building a {kib} distributable
The following commands will build a {kib} production distributable.
The following command will build a {kib} production distributable:
[source,bash]
----
@ -36,4 +36,4 @@ To specify a package to build you can add `rpm` or `deb` as an argument.
yarn build --rpm
----
Distributable packages can be found in `target/` after the build completes.
Distributable packages can be found in `target/` after the build completes.

4
docs/developer/getting-started/index.asciidoc
View file

@ -49,7 +49,7 @@ ____
(You can also run `yarn kbn` to see the other available commands. For
more info about this tool, see
{kib-repo}tree/{branch}/packages/kbn-pm[{kib-repo}tree/{branch}packages/kbn-pm].)
{kib-repo}tree/{branch}/packages/kbn-pm[{kib-repo}tree/{branch}/packages/kbn-pm].)
When switching branches which use different versions of npm packages you
may need to run:
@ -137,4 +137,4 @@ include::debugging.asciidoc[leveloffset=+1]
include::building-kibana.asciidoc[leveloffset=+1]
include::development-plugin-resources.asciidoc[leveloffset=+1]
include::development-plugin-resources.asciidoc[leveloffset=+1]

6
docs/developer/getting-started/running-kibana-advanced.asciidoc
View file

@ -73,8 +73,8 @@ settings].
[discrete]
=== Potential Optimization Pitfalls
* Webpack is trying to include a file in the bundle that I deleted and
is now complaining about it is missing
* Webpack is trying to include a file in the bundle that was deleted and
is now complaining about it being missing
* A module id that used to resolve to a single file now resolves to a
directory, but webpack isn’t adapting
* (if you discover other scenarios, please send a PR!)
@ -84,4 +84,4 @@ directory, but webpack isn’t adapting
{kib} includes self-signed certificates that can be used for
development purposes in the browser and for communicating with
{es}: `yarn start --ssl` & `yarn es snapshot --ssl`.
{es}: `yarn start --ssl` & `yarn es snapshot --ssl`.