Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[skip-ci][Maps][File upload] Geojson indexing and styling docs #41394

Merged
merged 16 commits into from
Sep 17, 2019

Conversation

kindsun
Copy link
Contributor

@kindsun kindsun commented Jul 17, 2019

[skip ci]

This PR adds a new section to the maps docs Indexing & Styling GeoJSON Data. It covers:

  • How to upload & index GeoJSON files
  • How to generate a heat map from the newly indexed data
  • How to style layers
  • How to organize layers for better presentation

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-gis

@kindsun kindsun added the release_note:skip Skip the PR/issue when compiling release notes label Jul 17, 2019
Copy link
Contributor

@thomasneirynck thomasneirynck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

This is a blog post more than it is reference documentation for the UX. It overlaps significantly with the getting-started doc we already have, and it contains a lot of duplicate information (e.g. setting the layer-names for all the layers. That works for a tutorial, less so for technical reference).

Maybe we can call this page Integrated example or something along those lines. @gchaps are there other examples in Kibana where the docs show a fully worked-out example of using an app end2end? I think Timelion might have.

The "import geojson" functionality needs its own page imho, stripped from the rest of this post. That can be short, but reference docs benefit of being short and to the point. It can then link to this page for users who want more a "tutorial" style of reading through the docs.

@gchaps
Copy link
Contributor

gchaps commented Jul 26, 2019

I agree with @thomasneirynck

  • I'd like see some information on what the geojson functionaliy is, why its important, and what value it brings to the user. Also, the basic process for uploading a geojson file.

  • The example is good, and we should use it, whether as a blog or in the docs. I especially like the last page, which is optional, but shows ways to improve the map. I'd recommend paring it down where it covers basic stuff like creating and saving a map and styling the layers, which is covered in the GS. Also, are all layers necessary?

  • Timelion does have an example. You can see it here.

  • The doc currently doesn't build now. You'll need to remove the anchor above "Creating a new Map". When you're ready to make it visible in the TOC, you'll need to include the file in the maps/index.asciidoc file.

Happy to help with this or doing an edit.

@thomasneirynck thomasneirynck self-requested a review July 26, 2019 17:22
@kindsun kindsun added the v7.4.0 label Aug 8, 2019
@spalger spalger added v7.3.2 and removed v7.3.1 labels Aug 22, 2019
@kindsun
Copy link
Contributor Author

kindsun commented Aug 22, 2019

@gchaps Thanks for the feedback! I've made the following updates:

  • Split GeoJSON upload out into its own separate doc with justification for why we use it and how this feature is useful
  • Reduced wording and generally make more succinct
  • Linked out to relevant docs where needed
  • Removed details like "Setting layer names"
  • Added wording indicating it's not necessary to use all files for download. It just tells a better story if they do
  • Removed breaking anchor above "Creating a new map"
  • Added new files to maps/index.asciidoc file
  • Removed unused images after streamlining

I left the final section mostly intact because it covers some detail on adding heatmaps that we just don't dive into in our other docs. Happy to revisit this though!

@nreese nreese changed the title [Maps][File upload] Geojson indexing and styling docs [skip-ci][Maps][File upload] Geojson indexing and styling docs Aug 22, 2019
@gchaps
Copy link
Contributor

gchaps commented Aug 28, 2019

@aaronjcaldwell Two things to fix to get the docs to build

  • Add the image fu_gs_select_source_file_upload.png
  • In geojson_upload.asciidoc, line 58, change geojson-upload-integrated-example tp indexing-geojson-data-example. It should look like this:
    <<indexing-geojson-data-example, integrated example>>

docs/maps/geojson-upload.asciidoc Outdated Show resolved Hide resolved
docs/maps/geojson-upload.asciidoc Outdated Show resolved Hide resolved
docs/maps/geojson-upload.asciidoc Show resolved Hide resolved
docs/maps/geojson-upload.asciidoc Outdated Show resolved Hide resolved
docs/maps/geojson-upload.asciidoc Show resolved Hide resolved
docs/maps/indexing-and-styling-geojson-data.asciidoc Outdated Show resolved Hide resolved
docs/maps/indexing-and-styling-geojson-data.asciidoc Outdated Show resolved Hide resolved
docs/maps/indexing-geojson-data-tutorial.asciidoc Outdated Show resolved Hide resolved
docs/maps/indexing-geojson-data-tutorial.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two minor comments. Otherwise LGTM.

docs/maps/index.asciidoc Outdated Show resolved Hide resolved
docs/maps/indexing-geojson-data-tutorial.asciidoc Outdated Show resolved Hide resolved
@kindsun kindsun added the v7.5.0 label Sep 17, 2019
@kindsun kindsun merged commit 985aa72 into elastic:master Sep 17, 2019
kindsun pushed a commit to kindsun/kibana that referenced this pull request Sep 17, 2019
…ic#41394)

* Mostly complete, first pass on file upload getting started

* More edits. Add supporting images

* Change name to 'indexing'

* Review feedback

* Update integrated example text per review feedback

* Rename integrated example -> data tutorial

* Add back accidentally deleted Select Source image file

* Review feedback

* Review feedback

* Move tutorial before troubleshooting

* Review feedback
kindsun pushed a commit to kindsun/kibana that referenced this pull request Sep 17, 2019
…ic#41394)

* Mostly complete, first pass on file upload getting started

* More edits. Add supporting images

* Change name to 'indexing'

* Review feedback

* Update integrated example text per review feedback

* Rename integrated example -> data tutorial

* Add back accidentally deleted Select Source image file

* Review feedback

* Review feedback

* Move tutorial before troubleshooting

* Review feedback
kindsun pushed a commit to kindsun/kibana that referenced this pull request Sep 17, 2019
…ic#41394)

* Mostly complete, first pass on file upload getting started

* More edits. Add supporting images

* Change name to 'indexing'

* Review feedback

* Update integrated example text per review feedback

* Rename integrated example -> data tutorial

* Add back accidentally deleted Select Source image file

* Review feedback

* Review feedback

* Move tutorial before troubleshooting

* Review feedback
rylnd added a commit to rylnd/kibana that referenced this pull request Sep 17, 2019
* master: (33 commits)
  [easy] Exclude __examples__ from coverage (elastic#45556)
  [DOCS] Update CCR links (elastic#44012)
  Use unique junit report filenames again (elastic#45897)
  [ftr/savedObjects] add simple saved object api client to ftr s… (elastic#45856)
  New visualization editor Lens (elastic#36437)
  Sort using unix timestamp value (elastic#43162)
  [APM] Use POST instead of implicit GET (elastic#45903)
  [Canvas] Converting workpad header components to typescript and adding i18n (elastic#45274)
  skip flaky test (elastic#45884)
  set IS_PIPELINE_JOB in intake jobs (elastic#45850)
  [Uptime] Fix/issue 48 integration popup closes after refresh (elastic#45759)
  [Logs UI] Support zoom by brushing in the log rate chart (elastic#45879)
  [DOCS] Changes name to host (elastic#45798)
  [ML] Add population job wizard test (elastic#45765)
  [skip-ci][Maps][File upload] Geojson indexing and styling docs (elastic#41394)
  remove setTimeoue for state change (elastic#45853)
  [Graph] Restructure folders and add readme (elastic#45782)
  [ML] Enhance job id error message (elastic#45349)
  [SIEM] Do not update state component when they did unmount (elastic#45847)
  [i18n] sync from 7.4 latest translations (elastic#45823)
  ...
kindsun pushed a commit that referenced this pull request Sep 18, 2019
… (#45898)

* Mostly complete, first pass on file upload getting started

* More edits. Add supporting images

* Change name to 'indexing'

* Review feedback

* Update integrated example text per review feedback

* Rename integrated example -> data tutorial

* Add back accidentally deleted Select Source image file

* Review feedback

* Review feedback

* Move tutorial before troubleshooting

* Review feedback
kindsun pushed a commit that referenced this pull request Sep 18, 2019
… (#45899)

* Mostly complete, first pass on file upload getting started

* More edits. Add supporting images

* Change name to 'indexing'

* Review feedback

* Update integrated example text per review feedback

* Rename integrated example -> data tutorial

* Add back accidentally deleted Select Source image file

* Review feedback

* Review feedback

* Move tutorial before troubleshooting

* Review feedback
kindsun pushed a commit that referenced this pull request Sep 18, 2019
… (#45900)

* Mostly complete, first pass on file upload getting started

* More edits. Add supporting images

* Change name to 'indexing'

* Review feedback

* Update integrated example text per review feedback

* Rename integrated example -> data tutorial

* Add back accidentally deleted Select Source image file

* Review feedback

* Review feedback

* Move tutorial before troubleshooting

* Review feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Deprecated-Use Team:Presentation]Team:Geo Former Team Label for Geo Team. Now use Team:Presentation Feature:File Upload release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.3.2 v7.4.0 v7.5.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants