🌟Help us feature more Docusaurus v1 users!

[yangshun]

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!

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.

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

• https://github.com/reduxjs/react-redux/ (@wgao19)
• https://github.com/jaredpalmer/formik (@shahednasser)
• https://github.com/node-serialport/node-serialport (@mikeattara)
• https://github.com/facebook/react-360 (@sunitasen)
• https://github.com/callstack/haul (@ellereeeee)
• https://github.com/19majkel94/type-graphql (@19majkel94)
• https://github.com/zamotany/react-slate (@andrewShillito)
• https://github.com/hemerajs/hemera (@alexperez)
• https://github.com/Cretezy/Noderize (@Rajekevin)
• https://github.com/react-native-sensors/react-native-sensors (@mikeattara)
• https://github.com/Khan/KaTeX (@haoqiang)
• https://github.com/PaulLeCam/react-leaflet (@zakariaharti)
• https://github.com/reduxjs/redux (@YifanM)
• https://github.com/scalameta/scalafmt (@ahtee)
• https://github.com/apache/pulsar (@NishealJ)
• https://github.com/boyney123/mockit (@NishealJ)
• https://testing-library.com/ (@hongarc)
• https://github.com/qiu8310/minapp (@qiu8310 + @NishealJ)

The process of adding users goes like this:

1. Comment below with the project you're interested in helping and make sure it's not already claimed.
2. 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.
3. Make an issue on the GitHub project, asking about featuring their project on Docusaurus (most people would be okay with that).
4. 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.
5. 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,
},

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

Have you read the Contributing Guidelines on issues?

Yes

[shahednasser]

I'm interested in working on Formik

[yangshun]

@shahednasser Thanks, have updated the description with your name.

[Rajekevin]

Hello @yangshun ,
I am interested in working on Noderize

[yangshun]

@Rajekevin Thanks, have updated the description with your name.

[sunitasen]

@yangshun I am interested in react-360

[yangshun]

@sunitasen It's yours! React-360 doesn't need permission because it's by FB. Go ahead and create the PR!

[andrewShillito]

@yangshun Hello. I'm interested in working on react-slate.

[yangshun]

@andrewShillito Go ahead. Thank you! It might be an issue because they don't have a logo. If that's the case, pick some other project.

[andrewShillito]

@yangshun Ok thank you! They have a couple of assets here and here that I was thinking might work. I'll check in with them, make a PR and if it works out cool and if not I'll select another project.

[andrewShillito]

@yangshun I'd be happy to do some more (starting with almond) unless you would prefer to reserve these for other newcomers to get involved with the project.

[yangshun]

@andrewShillito By all means! Go ahead! Thank you!

[alexperez]

Hello @yangshun
I’m interested in working on hemera.

[yangshun]

@alexperez It's yours!

[wgao19]

Hey @yangshun can I pick up React-Redux?

[yangshun]

@wgao19 definitely! I guess you don't need to ask for approval from React-Redux since you work on it 😉 Feel free to send us a PR anytime!

Please set pinned to true 😄

[ellereeeee]

Hello @yangshun ,

Can I please work on Haul?

[ymschaap]

@yangshun I made this form for Babel. It allows Docusaurus users to just fill out a form (instead of a fork, change file, add image, test, commit, PR), which will create a valid PR like this using a bot. Interested if I make the same feature available for Docusaurus?

[NishealJ]

Hi @yangshun , I've taken up apache pulsar Thanks !

[hong4rc]

@yangshun I created some issue to ask permission add showcase.

Can I create PR to update image?(add logo to this project instead of they image)

[yangshun]

@hongarc go ahead!

[yangshun]

Sorry I'm not understanding your question well. Let's follow the usual flow mentioned above. Feel free to message me on Discord, we can discuss there.

[hong4rc]

@yangshun Can I create PR others Docusaurus user, example https://openzeppelin.org/

[NishealJ]

Hi @arijitthehacker , can you please raise a PR for express-validator ?

[yangshun]

Closing this task and creating a part 2 issue to prevent noise to existing subscribers. Thank you for all your efforts thus far!