memphis icon indicating copy to clipboard operation
memphis copied to clipboard

Feature: Add a link to a JSON Schema guide on the UI

Open rnowling-memphis opened this issue 1 year ago • 3 comments

Current behavior

The documentation and UI both refer to specifying a schema for JSON. That said, it's not clear if it's using the official JSON Schema specification or not. Similarly, if a user is not familiar with the specification, it may not be clear how to write a schema.

Suggested solution

Create an overview of writing JSON schemas page in our documentation. The page should link to the official JSON Schema specification page if the user wants more details. Add a link to this page in the UI.

Additional context

No response

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

Contributing Docs

  • [X] I agree to follow this project's Contribution Docs

rnowling-memphis avatar May 10 '23 01:05 rnowling-memphis

Hey @rnowling-memphis, Thanks for raising that. Do you refer to this existing doc page? https://docs.memphis.dev/memphis/memphis/schemaverse-schema-management/getting-started/json-schema

And if yes, I didn't quite understand your idea for making it better. Would love a bit more details.

yanivbh1 avatar May 10 '23 06:05 yanivbh1

Okay, so there is a link ("Learn more") to the general Schemaverse documentation on the upper left-hand side of the screen.

That said, I'm wondering if it would be useful to add a third button on the upper right-hand part of the screen for the JSON page that links to a tutorial or getting started document for using JSON Schema?

It could either link to this:

https://json-schema.org/learn/getting-started-step-by-step.html

Or a Memphis-branded getting started document.

rnowling-memphis avatar May 10 '23 09:05 rnowling-memphis

@rnowling-memphis We can add the link at the end of the description of the JSON type. image

avrhamNeeman avatar May 10 '23 10:05 avrhamNeeman