docs: add Reddit Image Fetcher site to showcase #6856
Conversation
|
✔️ [V2] 🔨 Explore the source changes: 867b967 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/6224a1bf664b3a0008169023 😎 Browse the preview: https://deploy-preview-6856--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-6856--docusaurus-2.netlify.app/ |
Josh-Cena
changed the title
Josh-Cena
added
the
pr: documentation
Josh-Cena
changed the title
website/src/data/users.tsx
Outdated
| description: 'A JavaScript package for fetching reddit images, memes, wallpapers and more', | ||
| preview: require('./showcase/reddit-image-fetcher.png'), | ||
| website: 'https://arifszn.github.io/reddit-image-fetcher', | ||
| source: 'https://github.com/arifszn/reddit-image-fetcher', |
There was a problem hiding this comment.
This does not seem to contain your website's source?
There was a problem hiding this comment.
I was following RactivePlayer's structure and I had the impression the source is the library's source.
There was a problem hiding this comment.
Hmmm, indeed, that one probably slipped through the review. You do need to make the source point to your website's source. We care about your website, not your product ;)
There was a problem hiding this comment.
I see. Also, there are some more examples where the website source is not presented in the mentioned source URL e.g. Node SerialPort, Nocalhost. And other repos have the source as well as the library's source. So, you can guess why I misunderstood it as the library's source.
Currently, the website source is in another private repo. If it's the requirement then, I will move the website source to the library's subfolder. Which will take some time so you can close this PR for now. Or, source with null value is acceptable like Paubox, Prismatic, SmartCookieWeb?
There was a problem hiding this comment.
You can do either: public your website's source, or indicate that your website is not open-source. No need to close the current PR though, we can always wait ;D
Thanks for pointing those sites out, I've noted.
There was a problem hiding this comment.
Thanks. I will surely make the doc source open source soon and update the link. Could have made the repo public now but not super proud of the commit messages :p. For now, keeping the source as null.
|
@arifszn Do you plan to complete this any time soon? We are fine to keep it non-opensource for now, and you can always send follow-up PRs later once you are ready for open-sourcing. |
It will take some time so I think follow-up PR would be better. |
Motivation
Add Reddit Image Fetcher documentation site to showcase page
Have you read the Contributing Guidelines on pull requests?
Yes.
Test Plan
Run yarn run start:v2 and check that the page http://localhost:3000/showcase is rendered properly.
Related PRs
N/A