fairlearn
DOC Add survey callout box to documentation index page (#1541)
Description
Tests
- [x] no new tests required
- [ ] new tests added
- [ ] existing tests adjusted
Documentation
- [ ] no documentation changes needed
- [x] user guide added or updated
- [ ] API docs added or updated
- [ ] example notebook added or updated
Screenshots
Hi @TamaraAtanasoska and @hildeweerts This PR adds a callout box at the top of the documentation landing page to encourage readers to take the Fairlearn survey, as discussed in #1541. The implementation uses raw HTML for visual consistency and does not impact functionality or existing structure.
Please let me know if anything more maybe required or changed.
Hi @Mariam-ke, I see in addition to the website changes, there are also some changes to the metric frame file. Which issue do those changes address? In terms of scoping, it's generally better to address one issue within a PR.
@Mariam-ke would you be able to adjust this PR with just the edited user guide files? If you are not interested in continuing to work on this, let me know and I'll close the PR.
Hi @alliesaizan, thanks for the follow-up!
You're absolutely right about the scope. I'm planning to revise this PR to only include the intended documentation updates and remove the MetricFrame-related changes. I’ll make those adjustments and ping you.
Hi @alliesaizan the PR I have updated the PR to only include the survey callout box as discussed. The MetricFrame validation changes have been split into a separate PR. Let me know if any further changes are needed!
Hi @Mariam-ke can you include some screenshots of how this looks like completed (rendered)? thanks! Also, any warnings coming out during the documentation build, or the build is clear?
One comment from looking at the solution: I interpreted one of @hildeweerts's desired placements in https://github.com/fairlearn/fairlearn/issues/1541 as the static landing page that is not part of the documentation, am I right @hildeweerts (the second option)?
@TamaraAtanasoska yup, that is correct! many people will visit the landing page so it would be good to have a button in the hero too.
Hi @Mariam-ke can you include some screenshots of how this looks like completed (rendered)? thanks! Also, any warnings coming out during the documentation build, or the build is clear?
I echo this, pictures would be super helpful to understand how this looks!
I consider this not absolutely essential, but strongly preferred for the next release soon. @Mariam-ke any capacity to take this on until the end soon? It is really ok if not, there will be plenty of opportunities in the future!
Hi @TamaraAtanasoska The survey link was in the landing page, I have added a screenshot on the same. There were no build errors, I was just missing some basic packages which I installed and the build ran fine. Hope this is ok, please let me know if you would like me to add it to any other page or any other changes
Hi @Mariam-ke, I really like this solution, we should keep it! What Hilde was referring to was adding it as well to the main page somewhere, the fist that we see when when we access https://fairlearn.org. I have to say that I have very little opinions when it comes to design, but adding "a button" somewhere as @hildeweerts says is a good idea. Maybe something like this here: https://garden.io (the announcement strip), but on the very top? With some of the light blue colours from under? What do you think @Mariam-ke? How about you @alliesaizan?
One issue to mention is that the v0.13.0 one main branch is different from what you see online, but you can see the difference when you open it locally.
I haven't reviewed the code yet but I can do that at the very end once we have it all there. Thanks!
@TamaraAtanasoska I like the Garden website banner look. I am seeing right now the text is light grey on a light green background, so my only feedback would be to make the text a color with higher contrast (like black) so it's easier to read:
Hi @alliesaizan and @TamaraAtanasoska I updated the main page with the banner as well changed the banner and font color for the index page (screenshots attached) to match the website. let me know if you need me to add/change anything else.