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

Broken link to latest Kubernetes documentation #16066

Closed
sftim opened this issue Aug 25, 2019 · 14 comments · Fixed by #16814
Closed

Broken link to latest Kubernetes documentation #16066

sftim opened this issue Aug 25, 2019 · 14 comments · Fixed by #16814
Labels
kind/bug Categorizes issue or PR as related to a bug. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@sftim
Copy link
Contributor

sftim commented Aug 25, 2019

This is a Bug Report

Problem:
https://v1-15.docs.kubernetes.io/docs/ hyperlinks to the latest documentation, except that the link is actually to https://v1-14.docs.kubernetes.io/docs/ (because the href is null).

(oops!)
Here's the markup:

<div class="content deprecation-warning">
      <h3>
	 Kubernetes v1.15
	  documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the 
	 <a href="">latest version.</a>
      </h3>
    </div>

Proposed Solution:
Fix the link so that it takes readers to https://kubernetes.io/docs/

Pages to Update:
https://v1-15.docs.kubernetes.io/docs/
https://v1-14.docs.kubernetes.io/docs/
https://v1-13.docs.kubernetes.io/docs/

@Bradamant3
Copy link
Contributor

Bradamant3 commented Aug 25, 2019

@sftim I can't reproduce -- Chrome on Mac Mojave. Markup on the site looks OK (no null href):

<div class="content deprecation-warning">
        <h3>
            Kubernetes v1.14 
            documentation is no longer actively maintained. The version you are currently viewing is a 
            static snapshot. For up-to-date documentation, see the
            <a href="https://kubernetes.io/docs/home/">latest version.</a>
        </h3>
     </div>

@Bradamant3
Copy link
Contributor

Leaving my previous comment in place, but correcting it. Yup, reproduced. Given it's the latest version minus only one, seems a fairly high priority -- also bc seems likely that if we don't fix it'll repro for the next released version.

@sftim
Copy link
Contributor Author

sftim commented Aug 26, 2019

/priority important-longterm

@k8s-ci-robot k8s-ci-robot added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Aug 26, 2019
@zacharysarah
Copy link
Contributor

I'm able to reproduce as well. It's also reproducible in v1-13, but not in v1-12 or v1-11.

I notice that we introduced a string variable in v1.13, making a hard-coded reference the notable difference between v12 and v13.

@zacharysarah
Copy link
Contributor

Also, compare the difference between 1.13 and 1.14 behavior on the docs/ path:

  1. https://v1-14.docs.kubernetes.io/docs/ (no redirect to /docs/home/)

Screen Shot 2019-08-26 at 2 29 10 PM

  1. https://v1-13.docs.kubernetes.io/docs/ (automatically redirects to /docs/home/)

Screen Shot 2019-08-26 at 2 30 46 PM

I mention it because v1.13 behaves correctly but also returns a null href:

<section id="deprecationWarning">
  <main>
    <div class="content deprecation-warning">
      <h3>
	 Kubernetes v1.13
	  documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the 
	 <a href="">latest version.</a>
      </h3>
    </div>
  </main>
</section>

@zacharysarah
Copy link
Contributor

zacharysarah commented Aug 27, 2019

@jimangel I have an intution 🔮 this may involve a fix to line 8 on the same order of fixing line 6:

Kubernetes {{ .Page.Param "version" }}
{{ T "deprecation_warning" }}
<a href="{{ .Site.Params.currentUrl }}">{{ T "latest_version" }}</a>

UPDATE: ...Or more like #12743.

UPDATE: ...Or neither. I'm stumped.

@zacharysarah
Copy link
Contributor

After further testing, I notice one difference: at the fully qualified domain name (FQDN) only — https://v1-13.docs.kubernetes.io — the source populates the href correctly:

<section id="deprecationWarning">
  <main>
    <div class="content deprecation-warning">
      <h3>
	 Kubernetes v1.13
	  documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the 
	 <a href="https://kubernetes.io/docs/home/">latest version.</a>
      </h3>
    </div>
  </main>
</section>

Navigating to other URLs on the site (any URL with a path after the FQDN) shows that the shortcode fails to render/populate the href. For example, https://v1-13.docs.kubernetes.io/docs/home/ renders the null values shown above. ☝️

@zacharysarah
Copy link
Contributor

@rlenferink @kbarnard10 @BenTheElder 👋 Any Hugo thoughts here?

@BenTheElder
Copy link
Member

🤔 this does look a lot like gohugoio/hugo#5615

@zacharysarah
Copy link
Contributor

@BenTheElder It does--and gohugoio/hugo#5615 was solved in a release more recent than 0.53. That's a potential avenue for testing as well.

@zacharysarah
Copy link
Contributor

Bingo--upgrading Hugo to 0.57.2 solves it. @BenTheElder re:this thread, Exhibit A! :bowtie:

@BenTheElder
Copy link
Member

Excellent :-)

@sftim
Copy link
Contributor Author

sftim commented Sep 10, 2019

/kind bug

@k8s-ci-robot k8s-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label Sep 10, 2019
@sftim
Copy link
Contributor Author

sftim commented Sep 23, 2019

Revised the issue description as v1.16 is now out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants