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

docs: add HeroDevs support banners to specific pages. Add new menu item. #252

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

AndreAngelantoni
Copy link

Description

This PR does the following:

  • adds a new Support menu on the far right of the main navigation that points to the LTS page:

screenshot_3501

  • adds a new banner on the migration guides:

screenshot_3502

  • adds a new banner on versions of the documentation pages version 3 and lower:

screenshot_3503

The banners seemed to require swizzling the existing pages. If that wasn't correct, please advise.

Related Issues

Addresses fastify/fastify#5623.

Check List

Copy link
Member

@Eomm Eomm left a comment

Choose a reason for hiding this comment

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

Could you run the linter to get a green run&deploy?

/home/runner/work/website/website/src/theme/DocPage/index.js
Error:   79:10  error  'LatestVersionSuggestionLabel' is defined but never used  no-unused-vars

@AndreAngelantoni
Copy link
Author

AndreAngelantoni commented Oct 7, 2024 via email

@AndreAngelantoni AndreAngelantoni changed the title 5623: Add HeroDevs support banners to specific pages. Add new menu item. docs: add HeroDevs support banners to specific pages. Add new menu item. Oct 9, 2024
@Uzlopak
Copy link
Contributor

Uzlopak commented Oct 9, 2024

image
image

@@ -0,0 +1,126 @@
/**
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is that facebook copyright?

@AndreAngelantoni
Copy link
Author

AndreAngelantoni commented Oct 10, 2024 via email

@mcollina
Copy link
Member

@AndreAngelantoni it's 100% part of your PR.

@AndreAngelantoni
Copy link
Author

AndreAngelantoni commented Oct 10, 2024 via email

@AndreAngelantoni
Copy link
Author

My apologies, I thought that was for something else.

That was added by the Swizzler tool and has now been removed. Looking into the HTML detritus next.

@AndreAngelantoni
Copy link
Author

image image

I'm seeing this extra HTML in the current production docs:
https://fastify.dev/docs/latest/Reference/LTS/

I can certainly remove it as part of this PR but perhaps someone had intentions for it? (This is what I thought the other comment was referring to. Again, my apologies.)

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

The banner should not be shown for v4, which is still supported.
Looks good otherwise.

Screenshot 2024-10-15 at 15 23 19

@AndreAngelantoni
Copy link
Author

AndreAngelantoni commented Oct 15, 2024 via email

@AndreAngelantoni
Copy link
Author

The banner should not be shown for v4, which is still supported. Looks good otherwise.

Modification made. Please confirm.

@Eomm
Copy link
Member

Eomm commented Dec 6, 2024

Could you update the branch so we can deploy to staging?

Feel free to ping me to speed up the merge!

@AndreAngelantoni
Copy link
Author

/recheck

@AndreAngelantoni
Copy link
Author

@Eomm happy to work with you :-)

I rebased and am getting errors both locally and with the PR check:

Error: Can't render static file for pathname "/docs/latest/"
Error: Can't render static file for pathname "/docs/latest/docs/"
Error: Can't render static file for pathname "/docs/latest/docs/Guides/"

And several more. Perhaps an issue with the Docusaurus update?

@Eomm
Copy link
Member

Eomm commented Dec 18, 2024

I think there are few merge conflicts TBH will check it in a week or so

@Eomm Eomm force-pushed the aa/5623-mention-herodevs branch from 67d919c to 3e00152 Compare December 21, 2024 08:51
import useDocusaurusContext from '@docusaurus/useDocusaurusContext'
import Link from '@docusaurus/Link'
import Translate from '@docusaurus/Translate'
import { useActivePlugin, useDocVersionSuggestions } from '@docusaurus/plugin-content-docs/client'
Copy link
Member

Choose a reason for hiding this comment

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

I think this code should be upgraded to docusaurus v3:

Locally I get:

image

Note that I rebased this PR to main and other PR are working; #264

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