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: Update front page, contributing doc, and gallery code #825

Merged
merged 8 commits into from Jul 24, 2022

Conversation

choldgraf
Copy link
Collaborator

@choldgraf choldgraf commented Jul 19, 2022

This makes a few revisions of our contributing documentation as well as our front page, with the goal of being a little bit more "visual" and less text-heavy, and breaking content into more natural sections.

It looks like I've touched a bunch of files but that is mostly because of the renames and removing some files. I tried to break it up into natural commits, and also describe a few major changes below:

  • Rename contribute/ to community/ and break that up into a few more specific sub-sections.
  • Add a gallery of collaborators on this theme. I created a gallery of collaborators that we can use to show who has commit rights to the repository (long run I think it'd be better to define an actual "team" because "commit rights" is a pretty coarse metric, but this seems like a good start). 1
  • Rename demo/ to examples/ to mimic the title we use on the website (for each of these, I thought it wouldn't be a problem if the links break since those probably rarely get linked-to, but let me know if you disagree).
  • Cleaned up and modularized our community section to have more natural sub-sections in it, and to have them grouped so it's easier to navigate.
  • Cleaned up our front page so that it uses a gallery of features rather than a bunch of text. 2
  • Gallery Grid Directive: I also implemented a little Sphinx directive for our documentation that will generate galleries of images. I'm re-using that in two new places in our documentation, and also cleaned up our "demo gallery script" to re-use it as well, so it is a little bit simpler now (that script just generates the PNG files, it doesn't hand-write any directive text).

Footnotes

  1. image

@drammock
Copy link
Collaborator

this looks really nice! I'll try to make time for a full review soon, but 2 things I noticed just browsing the rendered pages:

  1. there is a duplicated "yet" above the headshots of maintainers (we don't yet have formal “team definitions” yet)
  2. should we acknowledge docusaurus as an inspiration?

@choldgraf
Copy link
Collaborator Author

@drammock done in latest commit!

@choldgraf
Copy link
Collaborator Author

Friendly ping for a review or approval on this one - I'd like to get these dangling PRs cleaned up so that we can release soon!

Alternatively: does anybody object to me merging this once we clean up the merge conflicts?

@drammock
Copy link
Collaborator

I won't be able to look again until Tuesday. Ideally one of the other devs has time to look; otherwise I don't object to a merge without full review. I did read through most of it and you already fixed what I spotted.

Copy link
Collaborator

@12rambau 12rambau left a comment

Choose a reason for hiding this comment

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

Let's start from the start, I really like the new look of the front page and the general design that you added (gallery, contributors etc).

From the implementation point of view nothing to complain about (I saw that you changed the json file for a yaml in the gallery but that's cosmetic to me)

Unfortunately my level of English doesn't allow me to proofread the content...

I'd say you can merge and people will create patches if they see something

@choldgraf
Copy link
Collaborator Author

OK I'll get the merge conflicts fixed and will then merge this in so that we can iterate more easily on the other PRs!

@choldgraf choldgraf force-pushed the front-page branch 4 times, most recently from 04f5fce to 4c72f0a Compare July 24, 2022 14:18
@choldgraf
Copy link
Collaborator Author

choldgraf commented Jul 24, 2022

There were quite a few merge conflicts that came up when I merged main into here. I think that we should give it a close look, but #834 sort-of depends on this one, so I'd suggest that we merge this in, and focus closer review efforts on #834 if possible so that there aren't too many moving parts at once.

I'll give it a couple of hours in case anybody wants to hold off, and will give this another quick pass before merging and focusing efforts on #834 since that's the more complex one

@choldgraf choldgraf changed the title Update our front page, contributing documentation, and gallery code DOCS: Update front page, contributing doc, and gallery code Jul 24, 2022
@choldgraf choldgraf merged commit d751eb5 into pydata:main Jul 24, 2022
@choldgraf choldgraf deleted the front-page branch July 24, 2022 19:14
@jarrodmillman jarrodmillman added this to the 0.10 milestone Jul 26, 2022
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.

None yet

4 participants