Oracle case study #1386
Oracle case study #1386
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1386 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 10 10
Lines 373 387 +14
Branches 94 103 +9
=========================================
+ Hits 373 387 +14 ☔ View full report in Codecov by Sentry. |
| tags: | ||
| - database | ||
| - relational | ||
| type: Case Study |
There was a problem hiding this comment.
It might be just me, but I think the article goes beyond the typical case study (i.e. here is how company X uses JSON Schema) into actually teaching something to the reader. From that point of view, maybe better to post it on the "Engineering" category?
There was a problem hiding this comment.
On the other side, I think Oracle's case study is indeed very technical, so maybe that's fine. Not sure. @benjagm what do you think?
|
I left a few comments, but overall I really like this blog post. Very interesting stuff on directly using JSON Schema for something cool that I think our readers will enjoy. |
There was a problem hiding this comment.
I think the content is fine, though I don't think we've had a case study quite like this. Normally they're more, "how JSON Schema helped us solve a problem." In this case, it's more, "how we're using JSON Schema to provide more features" which is fine.
There are a number of stylistic issues, and I think we should verify the preview and have one or more of the web admins have a look. There should be a style guide somewhere, but I'm on mobile and don't have immediate access to it. You can also look at some of the other posts for examples.
| |DATA| | ||
| |-| | ||
| |{"title":"New Blog Post","content": "This is the content of the blog post...","publishedDate":"2023-08-25T15:00:00Z","author":{"username":"authoruser","email":"[email protected]"},"tags":["Technology","Programming"]}| | ||
| |{"garbageDocument":true}| |
There was a problem hiding this comment.
I don't think this is going to render well. A long string in a table isn't going to be great. Is there another way this can be shown?
There was a problem hiding this comment.
I can definitely reformat the JSON doc inside the table.
There was a problem hiding this comment.
Would render like this be okay?
There was a problem hiding this comment.
This looks good to me. Again, let's have the web folks verify.
There was a problem hiding this comment.
In fact, I've tested it using the preview button View deployment and this didn't look that good (above is a screenshot from my IDE).
There was a problem hiding this comment.
Hence I've modified it so that now it renders as:
| <figure class="mt-10"> | ||
| <img class="rounded-lg" src="/img/posts/2025/oracle-case-study/form.webp"/> | ||
| <figcaption class="mt-2 mb-10 text-sm text-center text-gray-500">React frontend with input form generated from an annotated Oracle Database 23ai JSON schema.</figcaption> | ||
| </figure> |
There was a problem hiding this comment.
I think we have special markdown for components like this. Please check the blog post style guide.
There was a problem hiding this comment.
After scanning all the blog posts, I couldn't find any example not using either <div> <figure> <img> or markdown 
Please provide an example if you have one
There was a problem hiding this comment.
but maybe this is just this markdown component you are mentioning: 
|
This preview thing is terrific! |
|
I think some more spacing should be their to easily read the outputs. |
|
@cbum-dev There are definitely some style things that need to be addressed in general, but that needs to happen outside of this PR since it's work on the site itself. For this PR, we need to ensure the content matches our style guide:
@loiclefevre for reference, here are our blog guidelines. @benjagm I recall asking for a page like https://chirpy.cotes.page/posts/write-a-new-post/. Did we ever do that? I can't find that issue now. |
|
@gregsdennis, I miss some examples indeed with pictures and Danger, Tip, InfoBox. I've tried them and here is my feedback:
Hence I've tried to work around those as best as I could. |
|
I think for the purposes of this PR, we want to use the elements we've defined. If there are styling issues with those (and it seems there are), then the web team needs to address those separately. What I don't want is to have to update your blog post. I'd rather have the blog post set up correctly, then when the site is fixed, your post fixes itself. I do recognize that there is an element of branding and Oracle representation, but it's on our site, so we need to take that responsibility. |
|
@gregsdennis, @cbum-dev, I've pushed a new version where you can find the different issues mentioned:
I hope these get fixed :) |
|
Okay, my suggestion is to revert that last commit, but then open a separate PR with its content (the one with all the problems). We'll merge for now and start working on the issues. Once we've fixed the issues, then we have the second PR that we can just merge. |
The readability issue was already opened by me #1277 but waiting for the team's approval . |
Hi @gregsdennis, I've reverted to the last commit! PR1401 is the fixed version for the fixed blog-styled components. |
|
@gregsdennis, now you can review this final version of the PR. Thanks! |
There was a problem hiding this comment.
I'm happy with moving forward with this provided that we (@json-schema-org/docs-team) fix the issues highlighted above.
We'll take on the responsibility of completing #1401. Thanks for providing the basis.
|
Congratulations, @loiclefevre for your first pull request merge in this repository! 🎉🎉. Thanks for your contribution to JSON Schema! |
What kind of change does this PR introduce?
Adds the Oracle case study to the blog.
Issue Number:
N/A?
Summary
This PR adds the Oracle case study which presents numerous supported JSON Schema capabilities along code examples.
Does this PR introduce a breaking change?
No