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

Mention of file size for Uploading image via Kibana dashboard Image panel. #204747

Closed
wants to merge 1 commit into from

Conversation

aakash742
Copy link
Contributor

@aakash742 aakash742 commented Dec 18, 2024

Summary

As per the source code 10MiB is hardcoded limit for image upload in Kibana dashboard Image panels. And it's good to be evident in public documentation also.

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

…anels

As per the source code 10MiB is hardcoded limit for image upload. And it's good to be evident in public domain also.
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@aakash742 aakash742 changed the title Mention of file size for Uploading image via Kibana dashboard Image p… Mention of file size for Uploading image via Kibana dashboard Image panel. Dec 19, 2024
@aakash742 aakash742 added the docs label Dec 19, 2024
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

@aakash742 couple of issues here:

  • I suggest you flag this limitation in the page that's linked in this table (Kibana dashboard Image panels), rather than in the table itself.
  • Found some typos and you've left a comment in the text
  • I don't know if we need to link to the source code

@@ -33,6 +33,8 @@ Use one of the editors to create visualizations of your data. Each editor offers
| <<add-image,Image>>
| Personalize your dashboard with custom images

`Important: 10MiB is hardcoded limit for image upload.` <<<<<<<<<<<<<<< It's good to have this explicitely mentioned in the documentation. See https://github.com/elastic/kibana/blob/ed6a1a4e45e95b775bc3861c8cdbf06804c0e4af/src/plugins/files/common/default_image_file_kind.ts#L15
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
`Important: 10MiB is hardcoded limit for image upload.` <<<<<<<<<<<<<<< It's good to have this explicitely mentioned in the documentation. See https://github.com/elastic/kibana/blob/ed6a1a4e45e95b775bc3861c8cdbf06804c0e4af/src/plugins/files/common/default_image_file_kind.ts#L15
[IMPORTANT]
====
Image uploads are limited to 10 MiB.
====

Here's how I'd phrase it, and I'd put it in the file being linked to rather than the table.

@aakash742 aakash742 closed this Dec 24, 2024
@aakash742
Copy link
Contributor Author

Opened with correct page - #205140

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants