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

Fix hidden headings behind navigation bar [upstream only] #3454

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

Lennonka
Copy link
Contributor

@Lennonka Lennonka commented Nov 14, 2024

What changes are you introducing?

Fixing problem with misplaced headings when clicking an item in the TOC

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

UX improvement for Foreman Docs.

Previously, when you clicked an item in the table of contents, the browser scrolled to the top of the page and the actual heading was hidden behind the navigation bar.
With this fix, the heading is visible.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.13/Katello 4.15 (Satellite 6.17)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • Foreman 3.6/Katello 4.8
  • Foreman 3.5/Katello 4.7 (Satellite 6.13; orcharhino 6.6/6.7)
  • We do not accept PRs for Foreman older than 3.5.

Copy link

github-actions bot commented Nov 14, 2024

The PR preview for 3a6b064 is available at theforeman-foreman-documentation-preview-pr-3454.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@Lennonka Lennonka force-pushed the fix-navbar-hidden-heading branch 6 times, most recently from 44ce329 to 065762b Compare November 14, 2024 03:33
@Lennonka Lennonka marked this pull request as ready for review November 14, 2024 03:54
@Lennonka
Copy link
Contributor Author

I did it!!! 🎉

@Lennonka Lennonka changed the title Fix hidden headings behind navigation bar Fix hidden headings behind navigation bar [upstream only] Nov 14, 2024
Copy link
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

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

That's awesome, thank you Lena! Tested on https://theforeman-foreman-documentation-preview-pr-3454.surge.sh/nightly/Administering_Project/index-katello.html#Viewing_the_Ansible_Modules_admin ✔️

This was feedback by @lumarel at Foreman Birthday Party and I assume that a lot of people will be very happy with that change!

Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

Nice!

@ekohl ekohl merged commit 398142f into theforeman:master Nov 14, 2024
8 checks passed
@Lennonka Lennonka deleted the fix-navbar-hidden-heading branch November 14, 2024 16:43
@Lennonka
Copy link
Contributor Author

Aren't we going to cherry pick it to stable branches?

@ekohl
Copy link
Member

ekohl commented Nov 14, 2024

We probably should, but on my phone now. Anyone who can do it before I get to it should feel free to do so

@Lennonka
Copy link
Contributor Author

Cherry picked to supported Foreman releases:

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.

3 participants