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

[Docs][Maps] Include details about the headers requested and served by EMS #171659

Merged
merged 3 commits into from
Nov 28, 2023

Conversation

jsanz
Copy link
Member

@jsanz jsanz commented Nov 21, 2023

Fixes #129751

Summary

Extends the EMS documentation to detail request and response headers the browser sends to EMS resources and includes also a minimal curl command to request the response headers for same resource as well.

I tried to edit this in a way it does not take the whole page but happy to hear feedback or ideas on how to make this easier to digest.

vokoscreenNG-2023-11-21_16-39-52.mp4

Also, I am not sure if this is something worth adding to our release notes 🤔

Copy link
Contributor

Documentation preview:

@jsanz jsanz added release_note:skip Skip the PR/issue when compiling release notes docs backport:all-open Backport to all branches that could still receive a release labels Nov 21, 2023
@jsanz jsanz requested review from a team and amyjtechwriter November 21, 2023 15:53
@jsanz jsanz marked this pull request as ready for review November 21, 2023 15:54
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.

Thanks for putting these together. This is really useful information to document. What do you think about making the first tab the curl request?

@jsanz
Copy link
Member Author

jsanz commented Nov 24, 2023

Thanks for putting these together. This is really useful information to document. What do you think about making the first tab the curl request?

I'm not fully sure because the curl requests only contain some basic request headers as opposed to the listed ones in the Request tab.

I'll do the change in a separate commit so it is easy to revert if we prefer the other way.

@jsanz jsanz requested a review from nreese November 24, 2023 14:54
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

@jsanz
Copy link
Member Author

jsanz commented Nov 27, 2023

@amyjtechwriter, can you look at the texts on these changes when you have some time?

Copy link
Contributor

@amyjtechwriter amyjtechwriter left a comment

Choose a reason for hiding this comment

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

This looks great! The tabbed information tables look really fancy 💃💃, and the text is great.

@jsanz jsanz merged commit 0a7299b into elastic:main Nov 28, 2023
6 checks passed
@jsanz jsanz deleted the issue-129751 branch November 28, 2023 16:59
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Nov 28, 2023
…y EMS (elastic#171659)

Fixes elastic#129751

## Summary

Extends the EMS documentation to detail request and response headers the
browser sends to EMS resources and includes also a minimal `curl`
command to request the response headers for same resource as well.

I tried to edit this in a way it does not take the whole page but happy
to hear feedback or ideas on how to make this easier to digest.

https://github.com/elastic/kibana/assets/188264/27e83a5f-4d01-47a8-af2c-3739576bf56e

Also, I am not sure if this is something worth adding to our release
notes 🤔

(cherry picked from commit 0a7299b)
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
7.17 Backport failed because of merge conflicts
8.11

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 171659

Questions ?

Please refer to the Backport tool documentation

@jsanz
Copy link
Member Author

jsanz commented Nov 28, 2023

💚 All backports created successfully

Status Branch Result
7.17

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

jsanz added a commit to jsanz/kibana that referenced this pull request Nov 28, 2023
…y EMS (elastic#171659)

Fixes elastic#129751

## Summary

Extends the EMS documentation to detail request and response headers the
browser sends to EMS resources and includes also a minimal `curl`
command to request the response headers for same resource as well.

I tried to edit this in a way it does not take the whole page but happy
to hear feedback or ideas on how to make this easier to digest.

https://github.com/elastic/kibana/assets/188264/27e83a5f-4d01-47a8-af2c-3739576bf56e

Also, I am not sure if this is something worth adding to our release
notes 🤔

(cherry picked from commit 0a7299b)

# Conflicts:
#	docs/maps/connect-to-ems.asciidoc
kibanamachine added a commit that referenced this pull request Nov 28, 2023
…erved by EMS (#171659) (#172090)

# Backport

This will backport the following commits from `main` to `8.11`:
- [[Docs][Maps] Include details about the headers requested and served
by EMS (#171659)](#171659)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Jorge
Sanz","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-11-28T16:59:28Z","message":"[Docs][Maps]
Include details about the headers requested and served by EMS
(#171659)\n\nFixes #129751\r\n\r\n## Summary\r\n\r\nExtends the EMS
documentation to detail request and response headers the\r\nbrowser
sends to EMS resources and includes also a minimal `curl`\r\ncommand to
request the response headers for same resource as well.\r\n\r\nI tried
to edit this in a way it does not take the whole page but happy\r\nto
hear feedback or ideas on how to make this easier to
digest.\r\n\r\n\r\nhttps://github.com/elastic/kibana/assets/188264/27e83a5f-4d01-47a8-af2c-3739576bf56e\r\n\r\n\r\nAlso,
I am not sure if this is something worth adding to our release\r\nnotes
:thinking:","sha":"0a7299b0ac2aadfe47aa374002636341a032a6ed","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","backport:all-open","v8.12.0"],"number":171659,"url":"https://github.com/elastic/kibana/pull/171659","mergeCommit":{"message":"[Docs][Maps]
Include details about the headers requested and served by EMS
(#171659)\n\nFixes #129751\r\n\r\n## Summary\r\n\r\nExtends the EMS
documentation to detail request and response headers the\r\nbrowser
sends to EMS resources and includes also a minimal `curl`\r\ncommand to
request the response headers for same resource as well.\r\n\r\nI tried
to edit this in a way it does not take the whole page but happy\r\nto
hear feedback or ideas on how to make this easier to
digest.\r\n\r\n\r\nhttps://github.com/elastic/kibana/assets/188264/27e83a5f-4d01-47a8-af2c-3739576bf56e\r\n\r\n\r\nAlso,
I am not sure if this is something worth adding to our release\r\nnotes
:thinking:","sha":"0a7299b0ac2aadfe47aa374002636341a032a6ed"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/171659","number":171659,"mergeCommit":{"message":"[Docs][Maps]
Include details about the headers requested and served by EMS
(#171659)\n\nFixes #129751\r\n\r\n## Summary\r\n\r\nExtends the EMS
documentation to detail request and response headers the\r\nbrowser
sends to EMS resources and includes also a minimal `curl`\r\ncommand to
request the response headers for same resource as well.\r\n\r\nI tried
to edit this in a way it does not take the whole page but happy\r\nto
hear feedback or ideas on how to make this easier to
digest.\r\n\r\n\r\nhttps://github.com/elastic/kibana/assets/188264/27e83a5f-4d01-47a8-af2c-3739576bf56e\r\n\r\n\r\nAlso,
I am not sure if this is something worth adding to our release\r\nnotes
:thinking:","sha":"0a7299b0ac2aadfe47aa374002636341a032a6ed"}}]}]
BACKPORT-->

Co-authored-by: Jorge Sanz <[email protected]>
jsanz added a commit that referenced this pull request Nov 29, 2023
…erved by EMS (#171659) (#172092)

# Backport

This will backport the following commits from `main` to `7.17`:
- [[Docs][Maps] Include details about the headers requested and served
by EMS (#171659)](#171659)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Jorge
Sanz","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-11-28T16:59:28Z","message":"[Docs][Maps]
Include details about the headers requested and served by EMS
(#171659)\n\nFixes #129751\r\n\r\n## Summary\r\n\r\nExtends the EMS
documentation to detail request and response headers the\r\nbrowser
sends to EMS resources and includes also a minimal `curl`\r\ncommand to
request the response headers for same resource as well.\r\n\r\nI tried
to edit this in a way it does not take the whole page but happy\r\nto
hear feedback or ideas on how to make this easier to
digest.\r\n\r\n\r\nhttps://github.com/elastic/kibana/assets/188264/27e83a5f-4d01-47a8-af2c-3739576bf56e\r\n\r\n\r\nAlso,
I am not sure if this is something worth adding to our release\r\nnotes
:thinking:","sha":"0a7299b0ac2aadfe47aa374002636341a032a6ed","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","backport:all-open","v8.12.0"],"number":171659,"url":"https://github.com/elastic/kibana/pull/171659","mergeCommit":{"message":"[Docs][Maps]
Include details about the headers requested and served by EMS
(#171659)\n\nFixes #129751\r\n\r\n## Summary\r\n\r\nExtends the EMS
documentation to detail request and response headers the\r\nbrowser
sends to EMS resources and includes also a minimal `curl`\r\ncommand to
request the response headers for same resource as well.\r\n\r\nI tried
to edit this in a way it does not take the whole page but happy\r\nto
hear feedback or ideas on how to make this easier to
digest.\r\n\r\n\r\nhttps://github.com/elastic/kibana/assets/188264/27e83a5f-4d01-47a8-af2c-3739576bf56e\r\n\r\n\r\nAlso,
I am not sure if this is something worth adding to our release\r\nnotes
:thinking:","sha":"0a7299b0ac2aadfe47aa374002636341a032a6ed"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/171659","number":171659,"mergeCommit":{"message":"[Docs][Maps]
Include details about the headers requested and served by EMS
(#171659)\n\nFixes #129751\r\n\r\n## Summary\r\n\r\nExtends the EMS
documentation to detail request and response headers the\r\nbrowser
sends to EMS resources and includes also a minimal `curl`\r\ncommand to
request the response headers for same resource as well.\r\n\r\nI tried
to edit this in a way it does not take the whole page but happy\r\nto
hear feedback or ideas on how to make this easier to
digest.\r\n\r\n\r\nhttps://github.com/elastic/kibana/assets/188264/27e83a5f-4d01-47a8-af2c-3739576bf56e\r\n\r\n\r\nAlso,
I am not sure if this is something worth adding to our release\r\nnotes
:thinking:","sha":"0a7299b0ac2aadfe47aa374002636341a032a6ed"}},{"url":"https://github.com/elastic/kibana/pull/172090","number":172090,"branch":"8.11","state":"OPEN"}]}]
BACKPORT-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:all-open Backport to all branches that could still receive a release docs release_note:skip Skip the PR/issue when compiling release notes v7.17.16 v8.11.2 v8.12.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Maps] provide list of HTTP headers required to access EMS vector tiles when passing request through proxy
4 participants