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

This request is in response to issue #658. #671

Closed
wants to merge 1 commit into from

Conversation

chidiadi01
Copy link

@chidiadi01 chidiadi01 commented Apr 22, 2024

What kind of change does this PR introduce?

In this commit, the following changes were made:

  • Added 'required' keyword to all code samples in the 'Define properties' section
  • Reworded and restructured the 'Define properties' section for better understanding, and removed the 'Add the properties object' sub-section because it was unnecessary.
  • Added an info box to give more information about optional properties

Issue Number:

Screenshots/videos:
Screenshot of the reworded section

…llowing changes were done:

    - Added 'required' keyword to all code samples in the 'Define properties' section
    - Reworded and restructured the 'Define properties' section for better understanding, and removed the 'Add the properties object' sub-section because it was unnecessary.
    - Added an infobox to give more information about optional properties
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.

@chidiadi01 chidiadi01 marked this pull request as ready for review April 22, 2024 14:30
@chidiadi01 chidiadi01 requested a review from a team as a code owner April 22, 2024 14:30
@chidiadi01 chidiadi01 changed the title This commit is in response to issue #658. This request is in response to issue #658. Apr 22, 2024
Copy link
Member

@gregsdennis gregsdennis left a comment

Choose a reason for hiding this comment

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

There needs to be discussion as to what action is needed before a PR is submitted. There is no discussion on that issue.

@benjagm benjagm added the Status: In Progress This issue is being worked on, and has someone assigned. label Apr 23, 2024
@chidiadi01
Copy link
Author

chidiadi01 commented Apr 26, 2024

There needs to be discussion as to what action is needed before a PR is submitted. There is no discussion on that issue.

@gregsdennis, that means I have to wait for @bhavukkalra to respond?

@bhavukkalra
Copy link
Contributor

bhavukkalra commented Apr 26, 2024

Hey No Actually. You don't need to wait for me .We did had a discussion on this change was agreed upon that we should be adding diff changes to the Json entries. I am already in the process of completing that change. Works on my local but getting inconsistent results across different pages. trying to debug that out

Also, I think we use Info box currently to differentiate amongst different draft versions. Like If a certain keyword is not/is available in the draft and adding that as a generic info here could create confusion amongst readers.

I think that's what greg was trying to instantiate as well that a discussion should happen on what changes are currently in sync and which are not. So that a PR could be accurately reviewed

@gregsdennis
Copy link
Member

gregsdennis commented Apr 26, 2024

@chidiadi01 what I mean is that there's no discussion in the linked issue. It's just a proposal. There shouldn't be a PR from just a proposal. The issue needs to be discussed first to verify that s change needs to actually happen. Pre-emptively creating a PR is generally a waste of time because the work to be done hasn't been decided.

The discussion that @bhavukkalra is taking about happened only this week during the OCWM call, which was after I left that comment.

@chidiadi01
Copy link
Author

Oh...ok. Noted.

@benjagm
Copy link
Collaborator

benjagm commented May 16, 2024

Closing this PR as per #671 (comment)

@benjagm benjagm closed this May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: In Progress This issue is being worked on, and has someone assigned.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📝 Docs]: Simplify examples on getting started page
4 participants