feat: allow overriding prev and next links in frontmatter (#15755)

[AdeshGhadage]

Description

This pull request introduces a feature allowing content authors to override the prev and next navigation links directly in the front matter of a Hugo page. This PR addresses issue #15755

Reviewers

• Ambient
• Docs
• Installation
• Networking
• Performance and Scalability
• Extensions and Telemetry
• Security
• Test and Release
• User Experience
• Developer Infrastructure
• Localization/Translation

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: AdeshGhadage / name: Adesh Ghadage (e70e6e9, c7ebe2f, f1f46f2, 32cee9a, 464e0b8, 9b607c5, a119e8c, e29bae7)

[istio-policy-bot]

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been a while since you've been here. A few things you should know:

• You can learn about how we write and maintain documentation, our style guidelines,
  and the available web site features by visiting Contributing to the Docs.

• In the next few minutes, an automatic preview of your change will be built with
  a full copy of the istio.io website. You can find this preview by clicking on
  the Details link next to the deploy/netlify entry in the status section of this
  page.

• We care about quality, so we've put in place a number of checks to ensure our documentation
  is top-notch. We do spell checking, sanitize the Markdown, ensure all hyperlinks point to a
  valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
  lint_istio.io entry in the status section. Click on the Details link to get a list of the
  problems with your PR. Fix those problems and push an update; this will automatically re-run the
  tests. Hopefully this time everything will be perfect!

• Once your changes are accepted and merged into the repository, they will initially show up
  on https://preliminary.istio.io. The changes will be published to https://istio.io
  the next time we do a major release (which typically happens every 3 months or so).
  To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current
  release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

[istio-testing]

Hi @AdeshGhadage. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[dhawton]

/ok-to-test

[dhawton]

There was a build failure here, so this PR is not yet ready for review.

[AdeshGhadage]

I have solved build failure, I am new to istio. any more changed needed?

[craigbox]

A brief look at this suggests it isn't going to work how we need.
We need to have the original .NextInSection/.PrevInSection behavior (including the same formatting) unless prev or next is set in the front matter,, in which case it should be overridden.

Also, we don't have a reversePagination setting.

[craigbox]

Thanks adesh! It looks like it might work but I suspect you've changed which of "next" and "prev" are left and right.
(That's a really awkward thing about Hugo, so don't worry, it's hard to get right. Or left!)

To make the testing easier, it would be worth setting up a couple of next: and prev: in the front matter of some pages. Where I would explicitly suggest you put them:
/docs/ambient/getting-started/ should next: to /docs/ambient/getting-started/deploy-sample-app, and the latter should prev: to the former.

then /docs/ambient/getting-started/cleanup/ could optionally next: to /docs/ambient/install/ and vice versa.

[AdeshGhadage]

@craigbox The difficulty I faced stemmed from not fully understanding Hugo's multilingual mode. Initially, I tried to provide the URL for a specific language version directly to Site.GetPage, but this didn't work because Hugo resolves paths based on the current language. After learning about multilingual support, I realized I needed to handle language-specific pages properly by including the correct language code in the path. Once I figured this out, I was able to resolve the issue and successfully implement the functionality. I enjoyed learning a lot while solving this challenge!

[craigbox]

LGTM; it's there in EN, it's not there in ZH, it does what we wanted.
Thanks!

I'll approve this once the requested change is made. but I would like to encourage you to think about if there is a way to automate this: if you're on a page with children, then 'next' should be the first child, and the 'prev' should be the last page in the bundle from before.

Don't think too hard, but this demonstrates good pre-work for an upcoming mentorship :)

[craigbox]

On second thoughts we should remove this; people who find this page don't necessarily come from Getting Started.

Suggested change

prev: /docs/ambient/getting-started/cleanup

[AdeshGhadage]

LGTM; it's there in EN, it's not there in ZH, it does what we wanted.
Thanks!

I'll approve this once the requested change is made. but I would like to encourage you to think about if there is a way to automate this: if you're on a page with children, then 'next' should be the first child, and the 'prev' should be the last page in the bundle from before.

Don't think too hard, but this demonstrates good pre-work for an upcoming mentorship :)

I currently out on vacation i will do the changes as soon as i get back

[craigbox]

No rush, thanks.