website icon indicating copy to clipboard operation
website copied to clipboard

Replaced the deprecation-warning partial with docsy provided version-banner

Open SayakMukhopadhyay opened this issue 7 months ago • 8 comments
trafficstars

This PR replaces the deprecation-warning.html partial with the Docsy provided version-banner.html partial. It further customized the partial to ensure that existing features don't get removed all the while keeping the Docsy provided styling and HTML tree. The following are the changes:

  • Removed all styling from _custom.scss that used the now removed ids and classes related to the deprecation-warning partial.
  • Updated _default/baseof.html, blog/baseof.html, case-studies/single-baseof.html and docs/baseof.html to refer to version-banner.
  • In the new version-banner.html, apart from the content, which is customised for localisation, the deprecated param is still used as that param is used in multiple places and can be challenging to remove all of them at the same time. Alternatively, I can change the param only here keeping all other use of the deprecated param as is.
  • In hugo.toml, the currentUrl param is renamed to url_latest_version as that's the one preferred by Docsy and this param is not used anywhere else.

Issue

Closes: #50216

SayakMukhopadhyay avatar Mar 24 '25 17:03 SayakMukhopadhyay

/area web-development

SayakMukhopadhyay avatar Mar 24 '25 17:03 SayakMukhopadhyay

Pull request preview available for checking

Built without sensitive environment variables

Name Link
Latest commit 804388f903c854ee0e19f43a04c71f2bdcc9dd97
Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67ffa01b11a9ec00074a40fa
Deploy Preview https://deploy-preview-50217--kubernetes-io-main-staging.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Mar 24 '25 17:03 netlify[bot]

https://deploy-preview-50217--kubernetes-io-main-staging.netlify.app/community/ looks fine, but if I locally set the site to be an older version, it doesn't look quite right to me. Could we use a <section> with a blue background there?

sftim avatar Mar 27 '25 13:03 sftim

I was able to use a bit of CSS to make it look like before. Hope this is ok.

SayakMukhopadhyay avatar Mar 27 '25 14:03 SayakMukhopadhyay

It's not quite right (hyperlink text should be white, on that page), but it's close enough:

/lgtm

sftim avatar Mar 27 '25 14:03 sftim

LGTM label has been added.

Git tree hash: 4760c92ea898f80fb041c8bcd18cc7444ba0fdcb

k8s-ci-robot avatar Mar 27 '25 14:03 k8s-ci-robot

Oops, I will fix it when I am doing the another pass (which I will probably need to do anyway).

SayakMukhopadhyay avatar Mar 27 '25 14:03 SayakMukhopadhyay

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: divya-mohan0209

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • ~~OWNERS~~ [divya-mohan0209]

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot avatar Apr 16 '25 12:04 k8s-ci-robot

This has a merge conflict, @SayakMukhopadhyay. Could you please address it before we merge it? /hold

divya-mohan0209 avatar Apr 16 '25 12:04 divya-mohan0209

@divya-mohan0209 It's been fixed; it was a relatively small conflict. Probably would need another lgtm.

SayakMukhopadhyay avatar Apr 16 '25 12:04 SayakMukhopadhyay

Np, happy to give it another LGTM based on Tim's comment. I had to issue a hold since PROW does weird things sometimes. /unhold /lgtm

divya-mohan0209 avatar Apr 16 '25 12:04 divya-mohan0209

LGTM label has been added.

Git tree hash: a39f3bfc6ccf4325c9a28021afd5a53179f06aab

k8s-ci-robot avatar Apr 16 '25 12:04 k8s-ci-robot