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

Add a new section in the Docs for other JSON Schema resources #282

Closed
Tracked by #158
benjagm opened this issue Jan 25, 2024 · 25 comments
Closed
Tracked by #158

Add a new section in the Docs for other JSON Schema resources #282

benjagm opened this issue Jan 25, 2024 · 25 comments
Assignees
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@benjagm
Copy link
Collaborator

benjagm commented Jan 25, 2024

Description

If would be great to have resources section to show articles, papers, books podcasts and any other type of resources. We'll use json to store the data and provide dynamic UX.

Content types:

  • Articles
  • Books
  • Courses
  • Videos
  • Podcasts
  • Papers

Data structure example:

- title: Using JSON Schema
  url: https://books.apple.com/us/book/using-json-schema/id903248630
  year: 2014
  type: books
  summary: Learn and Apply JSON Schema by Example, with JavaScript (Node.js) and Python Programs
- title: JSON at Work
  url: https://www.oreilly.com/library/view/json-at-work/9781491982389/
  year: 2017
  type: books
  summary: A comprehensive overview of the JSON ecosystem, including JSON Schema

An amazing source of information will be: https://github.com/sourcemeta/awesome-jsonschema/blob/master/data.yaml

A possible prototype for this may be:

Resources menu:
Screenshot 2024-02-10 at 18 51 04

Resource category page (example):
Untitled presentation (1)

Do you think this work might require an Architectural Decision Record (ADR)? (significant or noteworthy)

No

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 10, 2024

I have some progress in this draft PR #281 but I'd love to have someone to continue the development.

@Gmin2
Copy link
Contributor

Gmin2 commented Feb 10, 2024

I have some progress in this draft PR #281 but I'd love to have someone to continue the development.

@benjagm can i help you with it?

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 10, 2024

can i help you with it?

@Min2who of course! Thanks a lot!! Please go ahead. (check my draft PR with the side menu logic)

@benjagm benjagm added the Status: Available No one has claimed responsibility for resolving this issue. label Feb 20, 2024
@Sanket-0510
Copy link
Contributor

@benjagm can I look into this?

@Akshaybagai52
Copy link
Contributor

Hey @benjagm
Can I work on this issue
Thanks

@benjagm benjagm 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 Feb 23, 2024
@benjagm
Copy link
Collaborator Author

benjagm commented Feb 23, 2024

@Akshaybagai52 Available to work on this one?

@benjagm benjagm assigned Sanket-0510 and unassigned Sanket-0510 Feb 23, 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 Feb 23, 2024
@Atharva-Kanherkar
Copy link

Hi, if no one is working on this, i would like to work on this.
Seems like a good issue to get hands on with the codebase!

@Akshaybagai52 Available to work on this one?

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 23, 2024

Please go ahead @Akshaybagai52 ! Thanks for your support!

@benjagm benjagm assigned benjagm and Akshaybagai52 and unassigned benjagm Feb 23, 2024
@benjagm benjagm 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 Feb 23, 2024
@Akshaybagai52
Copy link
Contributor

Thanks @benjagm for assigning this issue would share the progress

@Akshaybagai52
Copy link
Contributor

Hey @benjagm
is this looking good ?
image
and can you suggest me good icon if there is any already present in the repo because I've find some but they are big in size
and right now the routes I made is like that
image
is these correct or you want me to change the route name
Thanks

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 24, 2024

is this looking good ?

Looks good but we'd like the categories to be loaded dynamically from the YAML in the nodes "name"

@Akshaybagai52
Copy link
Contributor

Okay I will check that

is this looking good ?

Looks good but we'd like the categories to be loaded dynamically from the YAML in the nodes "name"

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 24, 2024

The YAML does not exists. You'll need to create or import it from : https://github.com/sourcemeta/awesome-jsonschema

And put it into the data folder.

@Akshaybagai52
Copy link
Contributor

The YAML does not exists. You'll need to create or import it from : https://github.com/sourcemeta/awesome-jsonschema

And put it into the data folder.

Is there any code related to YAML which is already present in the "website" repo because I've checked the code for docs section it is using same thing as I shown above

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 24, 2024

section it is using same thing as I shown above

Your approach to create new static links in the side bar is correct, however for this feature we need to dynamically create those links depending on the database with resources available in a new yaml file we are going to create inside the folder "data". You'll need to identify the types of resources available and build the menu:

- title: Using JSON Schema
  url: https://books.apple.com/us/book/using-json-schema/id903248630
  year: 2014
  type: books
  summary: Learn and Apply JSON Schema by Example, with JavaScript (Node.js) and Python Programs
- title: JSON at Work
  url: https://www.oreilly.com/library/view/json-at-work/9781491982389/
  year: 2017
  type: books
  summary: A comprehensive overview of the JSON ecosystem, including JSON Schema

And we'll import/convert data from here:
https://github.com/sourcemeta/awesome-jsonschema/blob/master/data.yaml

Before start coding, make sure you understand the requirements described in the body of the issue. The whole point of this feature is dynamically get data from that yaml and build the menu and the resource page with search engine.

If this is not clear in the description of the issue, happy to provide more clarifications.

@Akshaybagai52
Copy link
Contributor

Okay thanks for your clarification will work on this and ask you further questions if I have any

@Akshaybagai52
Copy link
Contributor

Hey @benjagm I'm able to get the details of the data.yaml file now is there any design of each route so that I can make the design of each page as well
Thanks

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 27, 2024

@Akshaybagai52 great progress! Please refer to the low-fi prototype provided in the body of the issue to have a sense about the UX/UI.

Feel free to be creative and evolve to make it much more cool.

@Akshaybagai52
Copy link
Contributor

@Akshaybagai52 great progress! Please refer to the low-fi prototype provided in the body of the issue to have a sense about the UX/UI.

Feel free to be creative and evolve to make it much more cool.

Thanks for suggestions. I will create the UI accordingly and it will take longer time because I also need to understand repo code

@Akshaybagai52
Copy link
Contributor

Hey @benjagm can you review this PR #395 right now only articles and books sections are working once one of them will become perfect according to review then I will fix remaining one
thanks

@Akshaybagai52
Copy link
Contributor

Hey @benjagm did you check this PR

@benjagm benjagm added this to the Docs Release 3 milestone Mar 6, 2024
@benjagm
Copy link
Collaborator Author

benjagm commented Mar 6, 2024

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 11, 2024

@Akshaybagai52 are you still working on this issue?

@Akshaybagai52
Copy link
Contributor

@Akshaybagai52 are you still working on this issue?

Yes I'm working on it will raise PR today

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 11, 2024

Closed as completed.

@benjagm benjagm closed this as completed Apr 11, 2024
@benjagm benjagm mentioned this issue Apr 15, 2024
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: In Progress This issue is being worked on, and has someone assigned.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants