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

[Maps] Add gdal integration #118633

Merged
merged 9 commits into from
Nov 16, 2021

Conversation

thomasneirynck
Copy link
Contributor

@thomasneirynck thomasneirynck commented Nov 15, 2021

Summary

Part of #116653

Adds GDAL to the data integrations page, linking to the blog post https://www.elastic.co/blog/how-to-ingest-geospatial-data-into-elasticsearch-with-gdal

This also adds a geo category.


Another PR will add a card for GeoJson. The latter one needs some more changes to the Maps-app, so preferring to keep that separate from here.

@thomasneirynck thomasneirynck added Team:Docs [Deprecated-Use Team:Presentation]Team:Geo Former Team Label for Geo Team. Now use Team:Presentation labels Nov 15, 2021
@thomasneirynck thomasneirynck requested review from a team as code owners November 15, 2021 23:04
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-gis (Team:Geo)

@@ -348,6 +348,7 @@ export class DocLinksService {
maps: {
guide: `${KIBANA_DOCS}maps.html`,
importGeospatialPrivileges: `${KIBANA_DOCS}import-geospatial-data.html#import-geospatial-privileges`,
gdalTutorial: `${ELASTIC_WEBSITE_URL}blog/how-to-ingest-geospatial-data-into-elasticsearch-with-gdal`,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Even though doc-links is not yet available server-side, adding the link here so it gets validated on release. This is the same approach we've taken with other data-integrations (e.g. language clients).

@thomasneirynck thomasneirynck changed the title Maps/add gdal integration [Maps] Add gdal integration Nov 15, 2021
@thomasneirynck thomasneirynck added Feature:Unified Integrations Unified Integrations view feature v8.1.0 release_note:skip Skip the PR/issue when compiling release notes labels Nov 15, 2021
x-pack/plugins/maps/server/register_integrations.ts Outdated Show resolved Hide resolved
'Upload shapefiles or ingest from relational databases such as PostGIS and OracleSpatial',
}),
uiInternalPath:
'https://www.elastic.co/blog/how-to-ingest-geospatial-data-into-elasticsearch-with-gdal',
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we link to something inside the product instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not yet. We only have the blog post for now. It is not uncommon for the data-integrations page to link to blog posts, e.g. the Fleet announcements

I do agree that in-app documentation would be helpful.

Copy link
Contributor

@nreese nreese left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for adding

Copy link
Member

@nickpeihl nickpeihl left a comment

Choose a reason for hiding this comment

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

just a nit, but otherwise lgtm!

x-pack/plugins/maps/server/register_integrations.ts Outdated Show resolved Hide resolved
Copy link

@alexfrancoeur alexfrancoeur left a comment

Choose a reason for hiding this comment

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

@thomasneirynck this looks good to me overall. I didn't run locally but dropped a comment around title / description that might be nice to adjust. I'm not sure if we want @gchaps feedback there or now. Let's discuss in our next sync, but something to consider for discoverability purposes is to create different documentation specific to data sources. Then we can add cards for each geospatial data source and increase discoverability of those.

customIntegrations.registerCustomIntegration({
id: 'ingest_with_gdal',
title: i18n.translate('xpack.maps.registerIntegrations.gdal.integrationTitle', {
defaultMessage: 'GDAL',

Choose a reason for hiding this comment

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

The screenshot shows something different here. We'll want to follow the guidelines for integrations. Upload geospatial data with GDAL sounded good.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sorry, that screenshot is out of date. Folded in @gchaps suggestions.

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
customIntegrations 79 80 +1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
core 269.2KB 269.2KB +83.0B
customIntegrations 6.1KB 6.1KB +10.0B
total +93.0B
Unknown metric groups

API count

id before after diff
customIntegrations 95 96 +1

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@thomasneirynck
Copy link
Contributor Author

@alexfrancoeur

but something to consider for discoverability purposes is to create different documentation specific to data sources. Then we can add cards for each geospatial data source and increase discoverability of those.

That'd be ideal scenario, but wondering if we could start with this. We've also have discussed a few times already for ingestion of shapefiles as well, to have an in-house solution.

imho the purpose of this card is mainly to communicate to users that there are already tools out there that will ingest your static data into Elasticsearch.

@thomasneirynck thomasneirynck merged commit 87312b4 into elastic:main Nov 16, 2021
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Nov 16, 2021
dmlemeshko pushed a commit that referenced this pull request Nov 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting [Deprecated-Use Team:Presentation]Team:Geo Former Team Label for Geo Team. Now use Team:Presentation Feature:Unified Integrations Unified Integrations view feature release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants