documentation-website icon indicating copy to clipboard operation
documentation-website copied to clipboard
verified publisher icon opensearch-project

chore: correct NDJSON extension for sample ecommerce data

Open hainenber opened this issue 1 year ago • 2 comments

Description

Describe what this change achieves. The sample ecommerce data file is not JSON per se but actually is [NDJSON](https://github.com/ndjson/ndjson-spec?tab=readme-ov-file) as suggested by the accompanying Content-Type header.

This PR is to remediate it.

Issues Resolved

Closes #[insert issue number] N/A

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all. All

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional. N/A

Checklist

  • [x] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

hainenber avatar Sep 22 '24 09:09 hainenber

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

github-actions[bot] avatar Sep 22 '24 09:09 github-actions[bot]

@peterzhuamazon Could you please review this PR?

kolchfa-aws avatar Sep 23 '24 13:09 kolchfa-aws

@mgodwan Could you please review this PR?

kolchfa-aws avatar Sep 24 '24 18:09 kolchfa-aws

@hainenber Thanks for making the change to ensure the file's naming/content-type adhere to specification. I agree with the overall change.

For my understanding, this is mostly around representation, or did you also experience issues while following this guide due to mismatch of content-type and actual file spec?

mgodwan avatar Sep 30 '24 00:09 mgodwan

Thanks for the review @mgodwan

It is only for representation. I've got no issue running the old cuủls.

hainenber avatar Sep 30 '24 01:09 hainenber