Skip to content

Update home page #26

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

Merged
merged 14 commits into from
Jun 3, 2022
Merged

Update home page #26

merged 14 commits into from
Jun 3, 2022

Conversation

twiecki
Copy link
Member

@twiecki twiecki commented Jun 1, 2022

No description provided.

@twiecki twiecki requested a review from OriolAbril June 1, 2022 15:15
@OriolAbril
Copy link
Member

I would keep user guide instead of learning as I feel it is more descriptive of the content inside it. There aren't only the links to books and videos but also the installation instructions, it has the glossary, it has the notebooks on core features, the guides we kept from pymc-devs/pymc#5538 should also appear there. I don't think removing those would be a good idea, and having them inside the "learning" navbar item feels a bit confusing. I think the options we have on this moving forward are:

  • Make "learning" a page inside the "user guide" navbar item
  • Have both "user guide" with all the pages mentioned above and "learning" as single page navbar section (similar to the v3 books+videos one) both appear on the navbar
  • (not sure it is a good idea) keep "learning" only in the navbar and find a different place for all the pages I mentioned above.

Side note, we can also add cards for the core notebooks to the example gallery page manually, I can do that once I have time.

Side note 2, the installaiton instructions page in https://www.pymc.io/projects/docs/en/latest/installation.html is there for now as a placeholder but should have the actual installation instructions instead of they being on the wiki. We discussed this a lot during GSoD and the wiki is very hard to find especially for new users who are the ones that need it the most, it also prevents us from having a "single link installation page" we can share and was probably one of the reasons we ended up (before GSoD) with at least 3 different installation instructions all on official docs yet incompatible between them.

@twiecki
Copy link
Member Author

twiecki commented Jun 1, 2022

@OriolAbril Ohh, https://www.pymc.io/projects/docs/en/latest/learning.html has the links on the left-side, I didn't catch that and was just confused by the main text.

Hm, I wonder if I'm confused whether others will be too, but I do like the content. Maybe the text on the main site was confusing to me and then I couldn't process what was happening on the left side.

@twiecki twiecki requested a review from OriolAbril June 2, 2022 14:13
Copy link
Member

@OriolAbril OriolAbril left a comment

Choose a reason for hiding this comment

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

first quick change, will continue reviewing

Copy link
Member

@OriolAbril OriolAbril left a comment

Choose a reason for hiding this comment

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

messed up in previous review, thought I was reviewing on pymc, not pymc.io

welcome.md Outdated
PyMC focuses on usability, flexibility, scalability, and extensibility.
Along with core model specification and fitting functionality,
PyMC integrates with {doc}`ArviZ <arviz:index>` for exploratory analysis of the results.
<img src="https://github.com/pymc-devs/brand/blob/main/logos/1-pymcdevs.png?raw=true"/>
Copy link
Member

Choose a reason for hiding this comment

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

I personally don't like the logo here very much, but happy to do whatever most people prefer

Copy link
Member Author

Choose a reason for hiding this comment

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

For me something is missing if it's not there and I try to scroll up. Probably because it's so ubiquitous for other projects to have the logo on the main page. It's also informative as it directly tells me that this is the landing page.

@@ -78,21 +76,6 @@ Sandra Meneses, one of the participants who submitted a PR
::::
:::::

## The PyMC project
Copy link
Member

Choose a reason for hiding this comment

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

I would keep this, and also add more content on the homepage as proposed here: #14 (comment). Not very opinionated on this being on the homepage, but I think all activities in addition to maintaining pymc should be showcased somewhere around here

Copy link
Member Author

Choose a reason for hiding this comment

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

I think the purpose is to show that we're doing more than Just PyMC. But then the activities listed are all very much in support of PyMC. For me it's a bit as if Pandas would say "we also write the Pandas documentation". It's not really surprising and thus has low information density.

And most of these are already on the page elsewhere. Office hours are in the announcements, the example gallery is in the navbar, PyMCon when it's relevant would show up in the announcements.

I do think some of these links would be useful to have here, but I think a user cares less about what we do and rather how he or she can actually accomplish whatever they came to the site for. So what if we replaced this with a: "Get Started" with links to:

  • Installation instructions
  • Beginner User Guide
  • Example Gallery
  • Discourse

Copy link
Member Author

Choose a reason for hiding this comment

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

I also added some of these pointers now to the "what sets us apart section" under a new "Community" item.

@twiecki twiecki requested a review from OriolAbril June 3, 2022 08:03
@twiecki twiecki changed the title Change user-guide to learning. Update home page Jun 3, 2022
@twiecki twiecki requested review from ricardoV94 and cluhmann June 3, 2022 15:28
@twiecki twiecki merged commit 1e1e4d8 into main Jun 3, 2022
@twiecki twiecki deleted the navbar_fix branch June 3, 2022 16:10
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.

4 participants