Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

Working on documentation #74

Merged
merged 1 commit into from
Feb 29, 2024
Merged

Working on documentation #74

merged 1 commit into from
Feb 29, 2024

Conversation

jzonthemtn
Copy link
Collaborator

@jzonthemtn jzonthemtn commented Feb 28, 2024

Work in progress but hopefully a start. Moved to a top-level documentation.md for visibility. I brought in @RasonJ's mappings docs and replaced the screenshot of the mappings with links to the mapping files in case the screen shot gets outdated.

@RasonJ
Copy link
Collaborator

RasonJ commented Feb 28, 2024

The purpose of the image is have the user focus on the main fields and not get lost in json ickiness. I'd prefer to have a collapsable display highlighting the primary fields, but without that, I think we need an image, at least while we're talking people through the schemas.

@epugh
Copy link
Member

epugh commented Feb 28, 2024

Could we be more elaborate in the mark down? I noticed that they do this kind of pattern: https://opensearch.org/docs/latest/query-dsl/term/term/#parameters to demonstrate a JSON based API, and then below the formatting...

@epugh epugh merged commit c6ad6a3 into main Feb 29, 2024
1 check passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants