Skip to content

Add announcement banner#1884

Merged
ischoegl merged 3 commits intoCantera:mainfrom
ischoegl:sphinx-banner
May 23, 2025
Merged

Add announcement banner#1884
ischoegl merged 3 commits intoCantera:mainfrom
ischoegl:sphinx-banner

Conversation

@ischoegl
Copy link
Member

@ischoegl ischoegl commented May 17, 2025

Changes proposed in this pull request

I noticed that the pydata-sphinx-theme project uses a banner to invite the community to contribute. I'd suggest doing the same for the Cantera project.

Here's a screenshot:

image

Checklist

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

@ischoegl ischoegl marked this pull request as ready for review May 17, 2025 14:48
@ischoegl ischoegl requested a review from a team May 17, 2025 14:48
Copy link
Member

@bryanwweber bryanwweber left a comment

Choose a reason for hiding this comment

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

This looks great. The only suggestion I have is to link to the Google group and suggest contributing there, too. I suspect we might be able to get people to answer questions from other users before code contributions.

@ischoegl
Copy link
Member Author

This looks great. The only suggestion I have is to link to the Google group and suggest contributing there, too. I suspect we might be able to get people to answer questions from other users before code contributions.

Thanks for the suggestion! I changed the link to check out our User Group.

@speth
Copy link
Member

speth commented May 17, 2025

I agree that making a more visible appeal for people to contribute to Cantera is a good idea.

However, I find the banner a little intrusive. It also seems to cause some positioning problems with the donation and NumFOCUS links that appear at the bottom of the navbar. As an alternative, what about putting this information at the bottom of the navbar along with those links?

@ischoegl
Copy link
Member Author

ischoegl commented May 17, 2025

I agree that making a more visible appeal for people to contribute to Cantera is a good idea.

However, I find the banner a little intrusive. It also seems to cause some positioning problems with the donation and NumFOCUS links that appear at the bottom of the navbar. As an alternative, what about putting this information at the bottom of the navbar along with those links?

@speth Thanks for pointing out the positioning issue - hadn't noticed, as it will go into the right place once you start scrolling (and the banner will disappear).

I actually like the intrusiveness of the banner, although I'm not convinced that the UG or the GH page are best for the redirects. Rather, I think that it would be good to have a page on 'getting involved' in the community section (which imho should move from the website to the main Sphinx docs, as the news section is outdated). It is my opinion that we need more people and shouldn't be shy about asking ...

@ischoegl
Copy link
Member Author

@speth / @bryanwweber ... I added a PR for a new 'getting involved' page on Cantera/cantera-website#269 (suggestions are welcome!). Once that is in place, this would be the landing page for the banner link.

@ischoegl
Copy link
Member Author

ischoegl commented May 18, 2025

@speth … I updated the landing page and fixed the padding. I can tweak the banner color further (I based it on the orange in the Cantera logo and either reduced saturation or value to 25%; the screenshot on top is updated).

Comment on lines 349 to 350
"This is a community-supported project. If you'd like to contribute, "
"<a href='https://cantera.org/getting-involved.html'>check out our 'Getting Involved' page</a>! "
Copy link
Member

Choose a reason for hiding this comment

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

For the first sentence, I think being more explicit would be good:

Cantera is a community-owned project and we need your help!

The second sentence, "contribute" doesn't sound right to me, but maybe that's just me ☺️ To actually offer a suggestion:

If you want to support Cantera, check out the Getting Involved page. Thank you!

Just a suggestion, you don't need to take it completely!

Copy link
Member Author

Choose a reason for hiding this comment

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

@bryanwweber ... thanks, but we need to be as short as possible (otherwise it will break into two lines as the window gets narrower). Here's another version:

Cantera is community-driven - want to help? Get involved here!

Copy link
Member

Choose a reason for hiding this comment

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

That makes sense. What about dropping the question so it's more active and urgent:

Cantera is community-driven and needs your help! Get involved here

Copy link
Member Author

@ischoegl ischoegl May 22, 2025

Choose a reason for hiding this comment

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

Sounds good! Here's what we have now:

image

and

image

@ischoegl ischoegl merged commit 5f094be into Cantera:main May 23, 2025
47 of 49 checks passed
@ischoegl ischoegl deleted the sphinx-banner branch May 23, 2025 00:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants