Skip to content
/ kibana Public
forked from elastic/kibana

Commit

Permalink
Minor developer guide doc changes (elastic#75763)
Browse files Browse the repository at this point in the history
# Conflicts:
#	docs/developer/best-practices/stability.asciidoc
#	docs/developer/getting-started/index.asciidoc
#	docs/developer/getting-started/running-kibana-advanced.asciidoc
  • Loading branch information
smith committed Aug 27, 2020
1 parent a8af78b commit 20499f7
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/developer/best-practices/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 5 additions & 5 deletions docs/developer/best-practices/stability.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,15 @@ storeinSessions?)
[float]
==== 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?

[float]
==== 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 changes: 2 additions & 2 deletions docs/developer/getting-started/building-kibana.asciidoc
Original file line number Diff line number Diff line change
@@ -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]
----
Expand Down Expand Up @@ -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 changes: 2 additions & 2 deletions docs/developer/getting-started/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -137,4 +137,4 @@ include::debugging.asciidoc[]

include::building-kibana.asciidoc[]

include::development-plugin-resources.asciidoc[]
include::development-plugin-resources.asciidoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ settings].
[float]
==== 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!)
Expand All @@ -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
Elasticsearch: `yarn start --ssl` & `yarn es snapshot --ssl`.
Elasticsearch: `yarn start --ssl` & `yarn es snapshot --ssl`.

0 comments on commit 20499f7

Please sign in to comment.