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

✨ Enhancement: Rebuild the getting started guide #549

Open
benjagm opened this issue Mar 16, 2024 · 6 comments · May be fixed by #687
Open

✨ Enhancement: Rebuild the getting started guide #549

benjagm opened this issue Mar 16, 2024 · 6 comments · May be fixed by #687
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Available No one has claimed responsibility for resolving this issue.

Comments

@benjagm
Copy link
Collaborator

benjagm commented Mar 16, 2024

Is your feature request related to a problem? Please describe

We are aware that learning JSON Schema is not easy and we also know that our docs needs a lot of improvement. But now, with the new feedback component we are even more clear about the areas that needs improvement and the getting started guide is clearly one of them.

After long consideration, I think the best approach is proceeding with a first iteration consisting on changing the section Validating JSON data against the schema.

We don't maintain or promote any validator over others and in addition we are not integrating any validator. This is great to keep our neutrality but it adds friction into new users journey. We are going to keep that neutrality but it will be great to allow the users feel the HAHA moment of getting a json message validated against a schema.

My proposal is to create a component that provides different valid and invalid examples for different uses cases following this prototype:

Screenshot 2024-04-18 at 15 51 05

The default example shown by the component is the one used for getting started. Considering that the examples are pre-recorded and we know the validation result.

  1. Initially the component shows the default schema instance. (this will be paremetrized in a yaml file)
  2. The user can select 2 or 3 different instances, valid and invalid and we show the result and the explanation why showing a green check when is valid and red cross when is invalid.
  3. We'll provide some other schema examples with instances so the users can see it working in different scenarios. We add simple and other more complex examples.
  4. We provide a download button to allow to download the schema and the selected instance so the user can try it with the validator of their choice.

The idea is let the users see the power of the json schema validation and show other real life examples to inspire them.

@benjagm benjagm added ✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Triage This is the initial status for an issue that requires triage. labels Mar 16, 2024
@benjagm benjagm self-assigned this Mar 16, 2024
@benjagm benjagm added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Triage This is the initial status for an issue that requires triage. labels Mar 16, 2024
@benjagm
Copy link
Collaborator Author

benjagm commented Mar 21, 2024

@VivekJaiswal18
Copy link
Contributor

Hello @benjagm, can I help you with this in any way.

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 8, 2024

Thanks Vivek. I still need to find some time to create a prototype with what I have in mind.

@benjagm benjagm removed their assignment Apr 17, 2024
@benjagm benjagm added Status: Available No one has claimed responsibility for resolving this issue. and removed Status: In Progress This issue is being worked on, and has someone assigned. labels Apr 17, 2024
@crampussm
Copy link
Contributor

Hey @benjagm can I work on this?

@benjagm
Copy link
Collaborator Author

benjagm commented May 10, 2024

Hey @benjagm can I work on this?

My apologies for the late response. I think @DhairyaMajmudar is working on this. Isn't it?

@DhairyaMajmudar
Copy link
Member

Yes I am currently working on this.

@DhairyaMajmudar DhairyaMajmudar linked a pull request May 10, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Available No one has claimed responsibility for resolving this issue.
Projects
Status: Todo
Status: In Progress
Development

Successfully merging a pull request may close this issue.

4 participants