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

set up rationale for theme gallery additions #1121

Closed
12rambau opened this issue Jan 18, 2023 · 2 comments · Fixed by #1390
Closed

set up rationale for theme gallery additions #1121

12rambau opened this issue Jan 18, 2023 · 2 comments · Fixed by #1390
Assignees
Labels
impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship tag: team process Team process, governance, and guidelines

Comments

@12rambau
Copy link
Collaborator

In the documentation, we have a dedicated page to show projects that are using our documentation. There are currently 18 projects referenced and building them takes a huge part of the documentation process (so much that we prevent it in the CI).

In recent weeks some extra projects wanted to be added to the list and my fear is that people use it as an advertisement page for their project. For me, this page is more of a list of fancy examples to guide new users in customizing their projects. I'm not sure adding extra vanilla pydata-sphinx-theme is going to help anyone.

What do you think if in this gallery we split the images into 2 lists:

  • the pydata projects: the theme is initially dedicated to them, they should, by all means, be listed here
  • the custom one: a list of carefully selected projects that embed interesting customization (extra navbar, map background, translation) to guide the users in the customization process

I would also like to update our documentation to specify that docs referenced in the gallery need to have a "little something" 😄

What do you think?

PS: Of course, early adopters will be kept because we love them very much

@drammock
Copy link
Collaborator

Agreed that the gallery is big enough already and we should consider being selective. Another idea is to have one section with screenshots and another that is just a list of links. Like "featured projects" (but without specially separating the pydata ones) and "other projects using the theme"

@drammock drammock changed the title set up rational for theme gallery additions set up rationale for theme gallery additions Jan 24, 2023
@choldgraf
Copy link
Collaborator

Also agreed - what about lile 3 marquee project with a preview that are relatively fixed. Then a longer list that is more like "logo + link"

@trallard trallard added the tag: team process Team process, governance, and guidelines label Feb 27, 2023
@12rambau 12rambau added the impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship label Jun 7, 2023
@12rambau 12rambau self-assigned this Jul 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship tag: team process Team process, governance, and guidelines
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants