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 WarriorJS to Docusaurus users #656

Merged
merged 2 commits into from
May 9, 2018

Conversation

olistic
Copy link
Contributor

@olistic olistic commented May 9, 2018

Motivation

WarriorJS is using Docusaurus for its documentation, added it to the users.

Also, the users array was growing quite large in siteConfig.js, so I took the liberty to extract it into a file inside of the website/data directory (also new). I'm fine with reverting this change if you don't think is a good one.

The one thing I'm now sure about is the changes to package-lock.json that were done when I run npm install on the root of the project. I don't know exactly why installing the dependencies would rewrite the lock file, but I suspect it could have something to do with the version of npm I'm using. Just in case:

$ node --version
v8.11.1
$ npm --version
6.0.0

Please let me know if I have to do something with regards to that. And thanks!

Have you read the Contributing Guidelines on pull requests?

Yes.

Test Plan

Same users being shown in the landing page:
screen shot 2018-05-09 at 14 28 43

WarriorJS now added to the users page:
screen shot 2018-05-09 at 14 29 01

Related PRs

N/A

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label May 9, 2018
@docusaurus-bot
Copy link
Contributor

docusaurus-bot commented May 9, 2018

Deploy preview for docusaurus-preview ready!

Built with commit 369d400

https://deploy-preview-656--docusaurus-preview.netlify.com

Copy link
Contributor

@yangshun yangshun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Looks good except that we prefer not to save it as a YAML file. Could you change it to JSON?

@@ -5,156 +5,10 @@
* LICENSE file in the root directory of this source tree.
*/

// List of projects/orgs using your project for the users page.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix! Let's save it as users.json instead so that we don't need an extra yaml loader.

@olistic olistic force-pushed the add-warriorjs-to-users branch from 06e05f6 to 369d400 Compare May 9, 2018 18:25
@olistic
Copy link
Contributor Author

olistic commented May 9, 2018

@yangshun Done! Changed it to JSON, and also reverted the changes to package-lock.json. Re-tested as well.

Copy link
Contributor

@yangshun yangshun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks for adding it! 😄

@yangshun yangshun merged commit ac718dd into facebook:master May 9, 2018
@JoelMarcey
Copy link
Contributor

Your project looks fun, @olistic 😄

@olistic
Copy link
Contributor Author

olistic commented May 9, 2018

Hey @JoelMarcey! Thanks 😄 It's still in its early stages, I'm focusing now on building a community of players and contributors. If you guys know people that could be interested I'd really appreciate help spreading the word out!

And thanks to you both and the rest of the people involved in Docusaurus 🙏 It helped me bring my documentation site to life with little to no effort and just worry about the content and nothing else.

cc. @yangshun

@olistic olistic deleted the add-warriorjs-to-users branch May 9, 2018 19:26
@yangshun
Copy link
Contributor

yangshun commented May 9, 2018

Very happy to hear that! 😄

@JoelMarcey
Copy link
Contributor

@olistic I believe this is the first Docusaurus site for a game, so I think I tweeted about it from our Docusaurus twitter account https://twitter.com/docusaurus/status/994333018071298048 😄

@olistic
Copy link
Contributor Author

olistic commented May 9, 2018

That's awesome @JoelMarcey! Thanks!

yangshun pushed a commit that referenced this pull request May 10, 2018
* migrating to react 16

* Add WarriorJS to Docusaurus users (#656)

* Separate users data from code

* Add WarriorJS to Docusaurus users

* [Feature] Introducing image compression using imagemin (#654)

* Introduce imagemin for compressing images

* Replace original images with the optimized ones

* Add imagemin-svgo to dependencies

* Remove console statement, replace let with const

* Replace let with const

* Add --skip-image-compression

* Run Prettier

* Fix header

* Prettier
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants