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.

Sign up for GitHub

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

Jump to bottom

[📝 Docs]: Add a note on caching schemas instead of repeatedly downloading #1323

Open
1 task done
kwennB opened this issue Jan 17, 2025 · 3 comments
Open
1 task done

[📝 Docs]: Add a note on caching schemas instead of repeatedly downloading #1323

kwennB opened this issue Jan 17, 2025 · 3 comments
Assignees
@Shivrajsoni
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: Accepted It's clear what the subject of the issue is about, and what the resolution should be. Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@kwennB
Copy link
Contributor

kwennB commented Jan 17, 2025

What Docs changes are you proposing?

Description

There isn’t any note on the website advising users to avoid repeatedly downloading schemas. Instead, tooling should cache the schemas within their application for efficiency. This guidance would help reduce unnecessary network requests and improve performance.

Proposed Solution

Add a section to the implementer’s section of the documentation that explains:

  • Why tooling should cache schemas locally.
  • The potential issues caused by repeatedly downloading schemas.
  • Examples or guidelines for implementing caching in tooling.

Note: Modify the proposed solution to be precise.

Expected Outcome

Clear guidance on caching schemas is added to the documentation.

Karen Etheridge takes credit for this issue.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@kwennB kwennB added Status: Available No one has claimed responsibility for resolving this issue. Status: Do not close This is a long term issue with dependant issues. This label prevent it to be closed automatically. Status: Triage This is the initial status for an issue that requires triage. 📝 Documentation Indicates improvements or additions to documentation. labels Jan 17, 2025
@Shivrajsoni
Copy link

can you assign this issue to me , I want to work upon it ?

@DhairyaMajmudar
Copy link
Member

Thank you for the issue @kwennB would you mind if I assign this issue to @Shivrajsoni ?

@DhairyaMajmudar DhairyaMajmudar added Status: Accepted It's clear what the subject of the issue is about, and what the resolution should be. and removed Status: Triage This is the initial status for an issue that requires triage. Status: Do not close This is a long term issue with dependant issues. This label prevent it to be closed automatically. labels Jan 18, 2025
@kwennB
Copy link
Contributor Author

kwennB commented Jan 19, 2025

Thank you for the issue @kwennB would you mind if I assign this issue to @Shivrajsoni ?

Yes sure @DhairyaMajmudar 👍🏾

@DhairyaMajmudar DhairyaMajmudar added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Available No one has claimed responsibility for resolving this issue. labels Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Shivrajsoni Shivrajsoni

Labels
📝 Documentation Indicates improvements or additions to documentation. Status: Accepted It's clear what the subject of the issue is about, and what the resolution should be. Status: In Progress This issue is being worked on, and has someone assigned.
Projects
JSON Schema Docs
Status: No status
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kwennB @DhairyaMajmudar @Shivrajsoni