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

docs: add a link to easily add your project with a form #1160

Closed
wants to merge 1 commit into from

Conversation

ymschaap
Copy link

@ymschaap ymschaap commented Dec 17, 2018

Re: this discussion: #1080 (comment)

Why:

Adding a project to the users list now involves forking, editing a js file, uploading a logo, creating a PR, reviewing. Which can be made much simpler with a Github bot that transforms a form submission into the right Pull Request.

What:

This PR links to a new web based submission form from the users page: https://build.amsterdam/your-company/docusaurus

How:

  • fill out the form
  • submit
  • backend creates a PR that updates the users.js and uploads the logo, and wraps it in a PR.

As gif:
2018-12-17 20 54 25

Example Bot PR:

How a bot PR looks like:
ymschaap#3

Let me know your thoughts if interested work on merging.

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

docusaurus-bot commented Dec 17, 2018

Deploy preview for docusaurus-preview ready!

Built with commit 4140cad

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

@JoelMarcey JoelMarcey added hackathon status: needs more information There is not enough information to take action on the issue. labels Jan 23, 2019
@JoelMarcey
Copy link
Contributor

@ymschaap Hi. This is actually really cool 😄

We definitely are interested in merging this, but we would need a few things first:

  1. Rebase the PR
  2. Can you make it so that new users are added alphabetically?
  3. Add docs on how to use this?

Thanks!

@yangshun yangshun changed the title Add a link to easily add your project with a form docs: add a link to easily add your project with a form Jan 23, 2019
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.

@ymschaap This is a really cool feature! On top of what Joel mentioned, I have the following questions:

  • Are we (Babel/Docusaurus maintainers), able to configure what we ask in the form or do we have to go through you if we want to make changes?
  • Many contributors want the final PR/commit made under their own name. Currently the PR is made using your bot. Can that be changed to be made using someone's GitHub account? I think the user would need to login via GitHub.

@ymschaap
Copy link
Author

ymschaap commented Jan 27, 2019

Great.

@JoelMarcey

  1. Rebase done
  2. Fixed sorting bug when adding new users (wasn't case-insensitive)
  3. What kind of docs are you thinking of? To explain what happens when you submit the form? Or how the tool works?

@yangshun

  1. I want to move the config for this form-to-PR tool to Github as well. Now I indeed make the change manually, but I want to open this up asap so maintainers can change it (and support all Docusaurus projects). But don't have a ETA yet.
  2. Now it tags the person in the PR. I have to dive into the Github API to see if the commit can be easily made under the user's name. Imho if they value the commit under their name, the original route to manually do a PR remains and would be their choice, no?

@endiliey
Copy link
Contributor

endiliey commented Mar 21, 2019

What are the blockers of this PR ?

@endiliey endiliey removed status: needs more information There is not enough information to take action on the issue. labels Mar 21, 2019
@endiliey
Copy link
Contributor

I think we are not going forward with this. Sorry. Thank you for the PR though 😉

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.

6 participants