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: Page in overview section to show Case Studies #440

Closed
Tracked by #158
benjagm opened this issue Mar 4, 2024 · 14 comments
Closed
Tracked by #158

✨ Enhancement: Page in overview section to show Case Studies #440

benjagm opened this issue Mar 4, 2024 · 14 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 Mar 4, 2024

Is your feature request related to a problem? Please describe

No

Describe the solution you'd like

it would be amazing to have a new page inside the overview section to show the case studies published in the blog.
This will be a data drive page reading results from a json file stored in our data folder. Each item of the file will have these fields:

  • logo
  • summary
  • List of links
    • lang : Language in ISO 639-1
    • url : link to the case study in that language

Please see this prototype:
Screenshot 2024-03-04 at 15 45 26

This is a prototype made by screenshot. Please complete the job using styles as per our site.

For the cards please consider using border shadows similar to the ones in the landing page:
Screenshot 2024-03-04 at 15 50 28

The case studies are available in the blog:
https://json-schema.org/blog?type=Case%20Study

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

No

@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. Status: Available No one has claimed responsibility for resolving this issue. and removed Status: Triage This is the initial status for an issue that requires triage. labels Mar 4, 2024
@benjagm benjagm moved this to Waiting for Contributions in Website Contributor Board Mar 4, 2024
@TamannaVerma99
Copy link
Contributor

Hey!
Since my previous issue is blocked by another one (the card component is yet to be made) , Is it ok if I can be assigned this issue?

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 4, 2024

Please go ahead. These cards is not going to be the standard ones. So no blockers expected here.

@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 Mar 4, 2024
@benjagm benjagm moved this from Waiting for Contributions to In Progress in Website Contributor Board Mar 4, 2024
@TamannaVerma99
Copy link
Contributor

TamannaVerma99 commented Mar 5, 2024

@benjagm, Had a few questions related to this one.

In order to add a custom card component which will read data from the specified JSON file, I would either have to use a .tsx file or a .mdx file. However, the present configuration for the pages/SideBar section specifies the use of only '.md' files. I tried finding out ways to implement components in .md itself, but conversion to .mdx is mandatory and based on the settings in [slug].page.tsx file (specifically, getStaticMarkdownPaths property) allows only .md files to be rendered.

So, will it be okay to modify this function to include .mdx files or is there another way round that can be used?

Also, for adding .mdx files, I will also need to configure the next.config.json file. So wanted to know your views before making such major changes. Thanks!

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 5, 2024

I would either have to use a .tsx

Please see the [slug].page.tsx in each subfolder of pages. This can help you think about how you can have your own page without md. I will recommend you to take a look to implementers page but be careful, this page doesn't have sidebar.

I hope this helps. We have multiple issues implementing similar features. Pleas see #429

@TamannaVerma99
Copy link
Contributor

Okay I will take reference from these issues! Thanks for the information.

@TamannaVerma99
Copy link
Contributor

@TamannaVerma99
Copy link
Contributor

Hey @benjagm
Just an update I am done with all the changes you gave on my previous pr ,I will raise another pr as soon as the card component will be merged.
Also I wanna know if there is any content that I have to write at the top of cards on casestudies page.
Thanks :)

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 8, 2024

Also I wanna know if there is any content that I have to write at the top of cards on casestudies page.

Make sure there is a title and intro paragraph and it will be enough. It can be "Loren impsum..." because I will be sending a PR with the texts before merging.

@TamannaVerma99
Copy link
Contributor

okay thanks got it!

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 11, 2024

@TamannaVerma99 please proceed with the integration if the component Card available in the parent branch. If you need to modify the component let's discuss first because others are integrating it.

@lalitkumawat1m
Copy link
Contributor

Hey @TamannaVerma99,
Is this issue open?
Do you need any help?

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 20, 2024

This is already merged to in release-3 branch. Will be closed as soon as that goes to main branch.

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 11, 2024

Closed as completed.

@benjagm benjagm closed this as completed Apr 11, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Ready to Review in Website Contributor Board 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

No branches or pull requests

3 participants