Improvements to our developer guide #67764

stacey-gammon · 2020-05-29T14:03:48Z

Dev Docs

Updated developer guide

Improves our developer guide:

Migrates CONTRIBUTING.md content into asciidoc
Moves CONTRIBUTING content into our developer guide
Cleans up the developer guide, removing outdated content, creating a structure proposed in [discuss] Future of Developer Documentation #41833 (comment)
Fixes Developer guide cleanup #67782

Sections removed

I removed the following sections as the contents are outdated or specific to legacy plugin development and/or angular:

Communicating with Elasticsearch
development-uiexports.
Modules and Autoloading

Restructuring the format

Previously separate into two categories:

Core development
Plugin development

New outline:

I will quickly follow this up by moving the source of the content outside kibana/docs/developer and into kibana/dev_docs

joshdover · 2020-05-29T16:42:19Z

Developing directly to the Kibana repo

Developing plugins externally

Maybe it makes more sense to have a generic "Developing plugins" section that is applicable to both scenarios and a "Developing plugins in the Kibana repo" section that is specific to 1st party plugins.

Otherwise I feel like these two sections just overlap a lot.

peterschretlen

Looks great, I like the new top level headings. I spent some time in the rendered docs and it feels pretty intuitive. There were a few minor issues with rendering, links etc. I left some review comments for those.

CONTRIBUTING.md

docs/developer/advanced/running-elasticsearch.asciidoc

docs/developer/best-practices/index.asciidoc

docs/developer/contributing/index.asciidoc

peterschretlen · 2020-06-24T15:19:15Z

docs/developer/contributing/index.asciidoc

+  * To **NOT** include your changes in the Release Notes, use `release_note:skip`.
+
+....
+# Dev Docs


Should this be removed? It looks out of place in the rendered doc.

@KOTungseth - what do you think about this section? I think you recently added it to the CONTRIBUTING guide and I moved here. Maybe give a title "For example, include these sections in your git issue:"?

I agree with Peter, we probably don't need it here. I think this is more for breaking changes.

docs/developer/contributing/linting.asciidoc

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

… into 2020-05-28-dev-docs

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

lcawl · 2020-07-03T21:04:55Z

I suggested some changes in stacey-gammon#15 as an example. If you like those changes, let me know and I can look at the rest of the sections too.

docs/developer/architecture/add-data-guide.asciidoc

KOTungseth · 2020-07-06T20:01:29Z

docs/developer/contributing/development-documentation.asciidoc

+repo as a sibling of your {kib} 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:**


Can you specify that node scripts/docs.js --open builds the Kibana docs? There are other product devs that tried to use this command on their own docs, and it didn't work.

So just leave out the part about this command opening the docs up in the browser?

KOTungseth · 2020-07-06T20:11:59Z

docs/developer/contributing/index.asciidoc

+  * To **NOT** include your changes in the Release Notes, use `release_note:skip`.
+
+....
+# Dev Docs


I agree with Peter, we probably don't need it here. I think this is more for breaking changes.

docs/developer/getting-started/debugging.asciidoc

docs/developer/getting-started/index.asciidoc

…v-docs

KOTungseth

There are so many great improvements in this PR! Thank you for making these changes. LGTM.

* contributing guide -> asciidoc * Update docs/developer/contributing/index.asciidoc Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> * Update docs/developer/best-practices/stability.asciidoc Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> * Update docs/developer/contributing/index.asciidoc Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> * address code review comments * Update docs/developer/contributing/development-documentation.asciidoc Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> * review comment updates * fix bad ref Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> # Conflicts: # CONTRIBUTING.md # docs/developer/contributing/development-functional-tests.asciidoc # docs/developer/contributing/development-unit-tests.asciidoc

* master: (28 commits) skip flaky suite (elastic#71361) [Ingest Manager] Add UI to enroll standalone agent (elastic#71288) Node options from cfg file for production (elastic#62468) [APM] Improvements to the ML Settings page (elastic#71309) add old .chromium to gitignore to prevent it from being accidentally committed [Ingest Manager] Simplify add/edit package config (integration) form (elastic#71187) Ensure Other bucket works on scripted fields. (elastic#71329) [APM] Anomaly detection setup link with alert if job doesn't exist (elastic#71229) [APM] Anomaly detection integration with transaction duration chart (elastic#71230) inclusive language (elastic#71438) [Ingest Manager] During fleet setup create an enrollment for every config (elastic#71308) Improvements to our developer guide (elastic#67764) [SIEM][Detections] Fixes index patterns order (elastic#71270) [Metrics + Logs UI] Add test for logs and metrics telemetry (elastic#70858) [Maps] Inclusive language (elastic#71427) [Logs UI] Unskip log highlight api integration test (elastic#71058) [Security_Solution][Resolver] Style adjustments per UX (elastic#71179) [Functional test] Increase the timeout to click new vis function (elastic#71226) [Discover] Migrate async import of embeddable factory to actual embeddable (elastic#70920) fix overflow (elastic#70723) ...

* contributing guide -> asciidoc * Update docs/developer/contributing/index.asciidoc Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> * Update docs/developer/best-practices/stability.asciidoc Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> * Update docs/developer/contributing/index.asciidoc Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> * address code review comments * Update docs/developer/contributing/development-documentation.asciidoc Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> * review comment updates * fix bad ref Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com> # Conflicts: # CONTRIBUTING.md # docs/developer/contributing/development-functional-tests.asciidoc # docs/developer/contributing/development-unit-tests.asciidoc

stacey-gammon force-pushed the 2020-05-28-dev-docs branch 12 times, most recently from 49500f9 to 6c30f3a Compare June 4, 2020 16:54

stacey-gammon force-pushed the 2020-05-28-dev-docs branch 5 times, most recently from cb05e5e to be6929a Compare June 7, 2020 12:36

stacey-gammon force-pushed the 2020-05-28-dev-docs branch 7 times, most recently from ac34d6f to 28170ab Compare June 23, 2020 19:35

contributing guide -> asciidoc

fd52ea7

stacey-gammon force-pushed the 2020-05-28-dev-docs branch from 28170ab to fd52ea7 Compare June 23, 2020 19:42

stacey-gammon requested a review from KOTungseth June 23, 2020 19:44

stacey-gammon mentioned this pull request Jun 23, 2020

[discuss] Future of Developer Documentation #41833

Closed

stacey-gammon marked this pull request as ready for review June 23, 2020 19:51

stacey-gammon changed the title ~~Migrates the contributing guide into asciidoc and moves to our developer guide~~ Improvements to our developer guide Jun 23, 2020

peterschretlen reviewed Jun 24, 2020

View reviewed changes

stacey-gammon and others added 7 commits June 24, 2020 12:11

Update docs/developer/contributing/index.asciidoc

5ea64b0

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

Update CONTRIBUTING.md

8f70754

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

Update docs/developer/best-practices/stability.asciidoc

f195a81

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

Update docs/developer/contributing/index.asciidoc

d418524

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

address code review comments

3bbe2fe

Merge branch '2020-05-28-dev-docs' of github.com:stacey-gammon/kibana…

8d4aaa2

… into 2020-05-28-dev-docs

Update docs/developer/contributing/development-documentation.asciidoc

c3b28e3

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

stacey-gammon requested a review from lcawl June 25, 2020 16:58

lcawl mentioned this pull request Jul 3, 2020

[DOCS] Edits developer docs layout stacey-gammon/kibana#15

Closed

2 tasks

joshdover mentioned this pull request Jul 6, 2020

Add developer docs item to PULL_REQUEST_TEMPLATE.md #70872

Closed

KOTungseth reviewed Jul 6, 2020

View reviewed changes

stacey-gammon mentioned this pull request Jul 9, 2020

Developer guide cleanup #67782

Closed

stacey-gammon added 4 commits July 9, 2020 09:50

review comment updates

2c5088c

Merge branch 'master' of github.com:elastic/kibana into 2020-05-28-de…

daa8062

…v-docs

Merge branch 'master' of github.com:elastic/kibana into 2020-05-28-de…

71dd9ba

…v-docs

fix bad ref

c709e51

stacey-gammon force-pushed the 2020-05-28-dev-docs branch from 23a969e to c709e51 Compare July 9, 2020 18:53

stacey-gammon requested a review from KOTungseth July 13, 2020 14:18

KOTungseth approved these changes Jul 13, 2020

View reviewed changes

stacey-gammon merged commit 0a516cf into elastic:master Jul 13, 2020

stacey-gammon mentioned this pull request Jul 13, 2020

[7.x] Improvements to our developer guide (#67764) #71455

Merged

jportner mentioned this pull request Sep 8, 2020

[7.9] Clean up the developer guide (#71631) #76983

Merged

peterschretlen mentioned this pull request Sep 18, 2020

Developer guide v1 #77958

Closed

rudolf mentioned this pull request Dec 5, 2020

Fix dead links to functional testing docs #85097

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improvements to our developer guide #67764

Improvements to our developer guide #67764

stacey-gammon commented May 29, 2020 •

edited

Loading

joshdover commented May 29, 2020

peterschretlen left a comment

peterschretlen Jun 24, 2020

stacey-gammon Jun 24, 2020

KOTungseth Jul 6, 2020

lcawl commented Jul 3, 2020

KOTungseth Jul 6, 2020

stacey-gammon Jul 9, 2020

KOTungseth Jul 6, 2020

KOTungseth left a comment

Improvements to our developer guide #67764

Improvements to our developer guide #67764

Conversation

stacey-gammon commented May 29, 2020 • edited Loading

Dev Docs

Updated developer guide

Sections removed

Restructuring the format

joshdover commented May 29, 2020

peterschretlen left a comment

Choose a reason for hiding this comment

peterschretlen Jun 24, 2020

Choose a reason for hiding this comment

stacey-gammon Jun 24, 2020

Choose a reason for hiding this comment

KOTungseth Jul 6, 2020

Choose a reason for hiding this comment

lcawl commented Jul 3, 2020

KOTungseth Jul 6, 2020

Choose a reason for hiding this comment

stacey-gammon Jul 9, 2020

Choose a reason for hiding this comment

KOTungseth Jul 6, 2020

Choose a reason for hiding this comment

KOTungseth left a comment

Choose a reason for hiding this comment

stacey-gammon commented May 29, 2020 •

edited

Loading