🌟 Help us feature more Docusaurus v1 users! (Part 2) #1437

yangshun · 2019-05-06T18:48:17Z

Tip: This is a beginner level Docusaurus task that requires almost no coding and is more targeted at newcomers to the project and Open Source.

📚 Documentation

We want to feature more Docusaurus users and we need your help!

This is a follow up of #1080 where we had around 20 new projects featured.

Docusaurus has a users page where we showcase projects using Docusaurus. This has the benefits of giving projects recognition and also lets the community and new users reference the creative ways of using Docusaurus. For example, Babel implemented the "copy code" button which we copied into our code, Reason has a full-width doc page and Prettier has a playground.

Criteria for adding a project/user

The project uses Docusaurus in creative ways/styling that looks different from the default
The project has gained significant popularity (e.g: >500 stars on GitHub, or ~1,000 subscribers on reddit, etc)
The project's Docusaurus website is already live

Here's a list of projects that we want to feature, in no particular order.

The process of adding users goes like this:

Comment below with the project you're interested in helping and make sure it's not already claimed.
Check if the project has a logo. If it doesn't have a logo, we could ask them to create one. If not, then we can't feature it as we don't have a way to feature projects without logos at the moment. Sorry about that.
Make an issue on the GitHub project, asking about featuring their project on Docusaurus (most people would be okay with that).
Get a reasonable-sized version of their logo (SVG preferred) and add it to website-1.x/static/img/users/<project-name-in-lower-snake-case>.{svg/png/jpg} not exceeding 512x512. Look into their website directory or project directory for the logo image file. Try to compress the logo first if possible using Photoshop or some online tools.
Modify website-1.x/data/users.js and add the project into the JS file, sorted alphabetically by caption:

{
  caption: 'The Project Name',
  image: '/path/to/image',
  infoLink: 'www.example.com', // Website. Can be GitHub repo URL if website doesn't exist
  fbOpenSource: false,
  pinned: false,
},

Run the Docusaurus website locally and see that the users page loads fine and shows the new user!
Run yarn lint and yarn prettier before submitting the PR.
Use the PR title - docs: showcase user <project name>.
In the PR summary, add a link to the PR where you've asked the project for permissions to include their logo.
Submit your PR!

Have you read the Contributing Guidelines on issues?

Yes

The text was updated successfully, but these errors were encountered:

yangshun · 2019-05-16T16:29:58Z

@hongarc would you like to take over Express Validator? It has been approved.

nickbui729 · 2019-05-17T13:17:52Z

Are there anymore projects that are up for grabs? First time contributor hear and would like to try one if any are up!

endiliey · 2019-05-17T13:26:26Z

Are there anymore projects that are up for grabs? First time contributor hear and would like to try one if any are up!

I think the best way going forward for this issue is like this:

Find a popular project that use Docusaurus. We prefer highly known project or a docusaurus site with lot of customization (not just using default template)

You can try to find it in here: https://github.com/facebook/Docusaurus/network/dependents
There are 2,300+ public repositories on GitHub that installs docusaurus.

Comment below with the project you're interested in helping and make sure it's not already claimed.
Follow the step above defined in the issue

Example: https://docs.openzeppelin.org/docs/get-started.html
You can send the PR for this @nickbui729

joybh98 · 2019-05-24T03:11:05Z

Hey @yangshun , can I take the Just (https://microsoft.github.io/just/) library?

yangshun · 2019-05-24T03:19:24Z

cc @co16353sidak who currently owns it.

@joybhallaa You can go ahead if @co16353sidak doesn't respond.

joybh98 · 2019-05-24T17:18:52Z

Okay, thank you!

yangshun · 2019-05-26T19:55:16Z

@hongarc Thanks for the list! I noticed there are some in the list that do not really qualify because:

They have Docusaurus in the repo but the site is not live (e.g. redux-devtools)
Not using Docusaurus at all (e.g. facebookresearch/Horizon)

I'll make those criteria clearer in the issue. Can you help filter them out?

ericbuss · 2019-06-10T01:27:04Z

@hongarc @yangshun I went ahead and filtered that list out. Some were duplicates, claimed already, or like mentioned, not live. I'll contact these projects about featuring them on Docusaurus as well.

yangshun · 2019-06-10T07:19:50Z

Nice work @ericbuss! Many thanks 😍

theNaut1lus · 2019-07-03T19:11:37Z

cc @co16353sidak who currently owns it.

@joybhallaa You can go ahead if @co16353sidak doesn't respond.

Sorry, been swamped with other work.
I have already submitted an issue onto just's repo for the necessities, they are yet to design (or decide on) a logo.

@yangshun I guess I never left the issue it is just on hold from the other end.
@joybhallaa let me sort this one out while you can take up another one.

(unless the mods think otherwise)

steric85 · 2019-10-13T07:41:24Z

Hey! Can I take https://graphql-code-generator.com/ ?

hong4rc · 2019-10-13T08:42:09Z

Hey! Can I take https://graphql-code-generator.com/ ?

It has been approved in dotansimha/graphql-code-generator#1821

I think you can help @NishealJ to create PR.

kenning · 2019-10-25T02:09:57Z

I'm using docusaurus for a social media video game i'm making. It's a work in progress, but i'm planning on open-sourcing the code to allow the users to contribute.

It's not going to have over 500 stars, but we have 2000 subscribers to our subreddit... https://reddit.com/r/collectivecg

I thought it might be an interesting way for you to show that the project is versatile enough to be used for purposes other than open source software development. What do you think?

(If you want to know more, there's an explainer video at https://collective.gg/)

endiliey · 2019-10-25T03:22:42Z

@kenning it looks awesome. We’ll be happy to showcase it :)

kenning · 2019-10-25T04:31:53Z

Thanks!! I'll get back to you when it's done.

kenning · 2019-11-14T03:38:32Z

@endiliey We've put the site up, you can find it here: https://www.collective.gg/library/welcome/

There's a public github repo where people can make changes, it also has a good README to introduce the game and why it's on github: https://github.com/collectivecardgame/library

endiliey · 2019-11-14T03:47:39Z

send pr :) looks great

kenning · 2019-11-14T04:03:03Z

oh duh haha

iamandrewluca · 2019-11-28T10:28:14Z

https://vector.dev/
https://uniforms.tools/

#789 (comment)

yangshun · 2019-11-28T15:56:57Z

Those are Docusaurus 2 sites and have already been added to the Docusaurus 2 showcase.

…

On Thu, Nov 28, 2019, 2:28 AM Andrew Luca ***@***.***> wrote: https://vector.dev/ https://uniforms.tools/ #789 (comment) <#789 (comment)> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1437?email_source=notifications&email_token=AAKBCHJLLWBHZUQURLP33HDQV6ML5A5CNFSM4HLCO2FKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEFMFDKQ#issuecomment-559436202>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKBCHOEFVSXHTQ3RF5C3D3QV6ML5ANCNFSM4HLCO2FA> .

holasoymalva · 2020-04-03T01:00:37Z

Hey! Can I take React data grid ? 🙂

hong4rc · 2020-04-03T01:43:11Z

Hey! Can I take React data grid ? 🙂

@ericbuss take it adazzle/react-data-grid#1687

We need wait to accept from adazzle

holasoymalva · 2020-04-14T14:50:59Z

Hello I would like to support, what projects are available? 🖖

yangshun · 2020-04-14T19:02:35Z

Everything here is up for grabs :)

hong4rc · 2020-04-15T14:17:17Z

Hello I would like to support, what projects are available? 🖖

You can use gh-dependents to know dependents project

const gd = require('gh-dependents');
 
gd('facebook/docusaurus').then(console.log);

and check it has ready in user showcase

yangshun · 2020-06-05T08:27:36Z

As we're moving towards D2, we'd like to focus our efforts there and not make further changes to D1 website. Thanks everyone for their efforts thus far in adding D1 projects to our showcase!

yangshun pinned this issue May 6, 2019

NishealJ mentioned this issue May 6, 2019

featuring graphql-code-generator in Docusaurus dotansimha/graphql-code-generator#1821

Closed

yangshun mentioned this issue May 6, 2019

🌟Help us feature more Docusaurus v1 users! #1080

Closed

18 tasks

endiliey added difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. labels May 13, 2019

This comment has been minimized.

Sign in to view

joybh98 mentioned this issue May 30, 2019

Featuring just in Docusaurus microsoft/just#116

Closed

endiliey unpinned this issue Jul 10, 2019

kenning mentioned this issue Nov 15, 2019

docs(v1): showcase user collective #1998

Merged

yangshun changed the title ~~🌟 Help us feature more Docusaurus users! (Part 2)~~ 🌟 Help us feature more Docusaurus v1 users! (Part 2) Feb 24, 2020

yangshun pinned this issue Feb 24, 2020

hong4rc mentioned this issue Apr 14, 2020

[Question] featuring react-typescript-cheatsheet in Docusaurus typescript-cheatsheets/react#216

Closed

yangshun closed this as completed Jun 5, 2020

yangshun unpinned this issue Jun 23, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌟 Help us feature more Docusaurus v1 users! (Part 2) #1437

🌟 Help us feature more Docusaurus v1 users! (Part 2) #1437

yangshun commented May 6, 2019 •

edited

Loading

yangshun commented May 16, 2019

nickbui729 commented May 17, 2019

endiliey commented May 17, 2019

joybh98 commented May 24, 2019

yangshun commented May 24, 2019 •

edited

Loading

joybh98 commented May 24, 2019

This comment has been minimized.

yangshun commented May 26, 2019

ericbuss commented Jun 10, 2019 •

edited by yangshun

Loading

yangshun commented Jun 10, 2019

theNaut1lus commented Jul 3, 2019

steric85 commented Oct 13, 2019

hong4rc commented Oct 13, 2019

kenning commented Oct 25, 2019 •

edited

Loading

endiliey commented Oct 25, 2019

kenning commented Oct 25, 2019

kenning commented Nov 14, 2019

endiliey commented Nov 14, 2019

kenning commented Nov 14, 2019

iamandrewluca commented Nov 28, 2019

yangshun commented Nov 28, 2019 via email

holasoymalva commented Apr 3, 2020

hong4rc commented Apr 3, 2020

holasoymalva commented Apr 14, 2020

yangshun commented Apr 14, 2020

hong4rc commented Apr 15, 2020

yangshun commented Jun 5, 2020

🌟 Help us feature more Docusaurus v1 users! (Part 2) #1437

🌟 Help us feature more Docusaurus v1 users! (Part 2) #1437

Comments

yangshun commented May 6, 2019 • edited Loading

📚 Documentation

Have you read the Contributing Guidelines on issues?

yangshun commented May 16, 2019

nickbui729 commented May 17, 2019

endiliey commented May 17, 2019

joybh98 commented May 24, 2019

yangshun commented May 24, 2019 • edited Loading

joybh98 commented May 24, 2019

This comment has been minimized.

yangshun commented May 26, 2019

ericbuss commented Jun 10, 2019 • edited by yangshun Loading

yangshun commented Jun 10, 2019

theNaut1lus commented Jul 3, 2019

steric85 commented Oct 13, 2019

hong4rc commented Oct 13, 2019

kenning commented Oct 25, 2019 • edited Loading

endiliey commented Oct 25, 2019

kenning commented Oct 25, 2019

kenning commented Nov 14, 2019

endiliey commented Nov 14, 2019

kenning commented Nov 14, 2019

iamandrewluca commented Nov 28, 2019

yangshun commented Nov 28, 2019 via email

holasoymalva commented Apr 3, 2020

hong4rc commented Apr 3, 2020

holasoymalva commented Apr 14, 2020

yangshun commented Apr 14, 2020

hong4rc commented Apr 15, 2020

yangshun commented Jun 5, 2020

yangshun commented May 6, 2019 •

edited

Loading

yangshun commented May 24, 2019 •

edited

Loading

ericbuss commented Jun 10, 2019 •

edited by yangshun

Loading

kenning commented Oct 25, 2019 •

edited

Loading