Skip to content

Add page for the Community Github Org with list of repos#884

Merged
cpojer merged 1 commit intofacebook:masterfrom
matt-oakes:community-repos
May 20, 2019
Merged

Add page for the Community Github Org with list of repos#884
cpojer merged 1 commit intofacebook:masterfrom
matt-oakes:community-repos

Conversation

@matt-oakes
Copy link
Copy Markdown
Contributor

What's in this PR?

  • A script to fetch the list of repos from the Community Github Org and then parse out the information that we need.
  • An example page to display the repo information.
  • Run the scripts when the CI server, and Netlify, builds the website.

Still to do

This PR is meant to start a conversation about what we would like to include on the community page of the website. There are still lots of open questions:

What do we want to include on the community page?

Currently, I have just included the first paragraph of the meta repo and a bare bones repo list. There is a lot more we could include:

  • Highlight the key repos like "releases", "discussions-and-proposals", and "meta".
  • Include some information about why the org exists and what the difference between the libraries contained in it and from other community members is.
  • Highlights of the guidelines we impose and why it matters (consistent code standards and well tested).

How do we make the repo list nicer?

Currently, I have just used the styling of the "showcase" to make a grid and included the repo name and the description. Other information we could include is:

  • Number of stars.
  • How "standards-compliant" the repo is.
  • How active the repo is.
  • How many downloads it has had.

Where should this page live in the navigation structure?

There is currently a "community" link in the header, however, this goes to the "help" page which then includes help links and links to 3rd-party communities. This is useful information so we should keep it.

To me, it makes sense to have the new Community page go to the new page in this PR and have the current Help page accessible under a new "Help" link in the header.

Anything else?

This is meant to start a conversation, so... GO!

@react-native-bot
Copy link
Copy Markdown

Oops, something went wrong with this deploy preview.

@charpeni can you look at this?

1 similar comment
@react-native-bot
Copy link
Copy Markdown

Oops, something went wrong with this deploy preview.

@charpeni can you look at this?

@matt-oakes
Copy link
Copy Markdown
Contributor Author

⬆️ That's likely because I've added a new script to the preview script which required a GITHUB_TOKEN environment variable. This is used to get the community repos from the Github API on each deploy.

@grabbou
Copy link
Copy Markdown
Contributor

grabbou commented Apr 16, 2019

Great work! Number of issues / opened PRs might also be nice, but I think this is something we can configure later too.

@cpojer
Copy link
Copy Markdown
Contributor

cpojer commented Apr 17, 2019

This is amazing.

@matt-oakes
Copy link
Copy Markdown
Contributor Author

@cpojer @grabbou Should I modify this PR to only include the data fetching part for now and then we can follow it up with another PR to actually make use of the data? I don't feel like I'm the best person to be making decisions about the website structure on my own but this PR can be a step towards it.

Let me know if that works for you?

@cpojer
Copy link
Copy Markdown
Contributor

cpojer commented Apr 17, 2019

Yeah that works for me :)

This lays the foundation for using the information from the siteConfig in a community page.
@matt-oakes matt-oakes marked this pull request as ready for review April 17, 2019 21:50
@react-native-bot
Copy link
Copy Markdown

Oops, something went wrong with this deploy preview.

@charpeni can you look at this?

@matt-oakes
Copy link
Copy Markdown
Contributor Author

Thanks for the reviews everyone!

I have removed the page I created and left this PR to just be the sync script. Someone will need to check that that CircleCI and Netlify has the correct GITHUB_TOKEN environment variable before this gets merged.

The next step will be for someone to make use of the new data in a community page 👍

@matt-oakes
Copy link
Copy Markdown
Contributor Author

I forgot to say, I also added open issues and PRs to the data 👍

@react-native-bot
Copy link
Copy Markdown

Deploy preview for react-native ready!

Built with commit e6d0814

https://deploy-preview-884--react-native.netlify.com

Changes to docs/ are reflected in the next "master" version.

Thank you for your contributions.

How to ContributeDocumentation Sources

@charpeni
Copy link
Copy Markdown
Contributor

Thanks for doing this!

I just configured Netlify with a GITHUB_TOKEN, we'll be able to play with it.

@matt-oakes
Copy link
Copy Markdown
Contributor Author

Perfect. Thanks!

@cpojer
Copy link
Copy Markdown
Contributor

cpojer commented May 17, 2019

What's the status of this? Where can I check out what this looks like? I'd like to get this in :)

@matt-oakes
Copy link
Copy Markdown
Contributor Author

@cpojer I removed all of the visible changes from this PR as there was no consensus on how the data should be displayed. It now just adds the data loading logic. It's ready to merge, but you'll need another PR to display the data somewhere.

Copy link
Copy Markdown
Contributor

@cpojer cpojer left a comment

Choose a reason for hiding this comment

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

Cool, let's merge this and then build a fancy page on top of it. Thank you for making this!

@cpojer cpojer merged commit 540bf78 into facebook:master May 20, 2019
@nearestnabors
Copy link
Copy Markdown
Contributor

@matt-oakes I'm interested in picking this up. Are you available to collaborate?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants