Skip to content

Commit

Permalink
Block web crawlers on v1.5-branch (#3858)
Browse files Browse the repository at this point in the history
* Block web crawlers on `v1.5-branch`

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Enable archived version header

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Fix archived version warning

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

---------

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
  • Loading branch information
thesuperzapper authored Sep 12, 2024
1 parent 08cb92a commit 5775eb0
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 33 deletions.
20 changes: 4 additions & 16 deletions OWNERS
Original file line number Diff line number Diff line change
@@ -1,19 +1,7 @@
approvers:
- animeshsingh
- Bobgy
- chensun
- andreyvelich
- james-jwu
- knkski
- shannonbradshaw
- zijianjoy
reviewers:
- 8bitmp3
- aronchick
- berndverst
- dansanche
- dsdinter
- Jeffwan
- jinchihe
- nickchase
- pdmack
- jbottum
- johnugeorge
- terrytangyuan
- zijianjoy
18 changes: 7 additions & 11 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -98,30 +98,30 @@ disableKinds = ["taxonomy", "taxonomyTerm"]
gcs_engine_id = "007239566369470735695:624rglujm-w"

# Text label for the version menu in the top bar of the website.
version_menu = "Kubeflow Version"
version_menu = "v1.5"

# The major.minor version tag for the version of the docs represented in this
# branch of the repository. Used in the "version-banner" partial to display a
# version number for this doc set.
version = "master"
version = "v1.5"

# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
archived_version = false
archived_version = true

# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version = "https://kubeflow.org/docs/"
url_latest_version = "https://www.kubeflow.org/docs/"

# A variable used in various docs to determine URLs for config files etc.
# To find occurrences, search the repo for 'params "githubbranch"'.
githubbranch = "master"
githubbranch = "v1.5-branch"

# These entries appear in the drop-down menu at the top of the website.
[[params.versions]]
version = "master"
version = "Latest"
githubbranch = "master"
url = "https://master.kubeflow.org"
url = "https://www.kubeflow.org"
[[params.versions]]
version = "v1.5"
githubbranch = "v1.5-branch"
Expand Down Expand Up @@ -166,10 +166,6 @@ disableKinds = ["taxonomy", "taxonomyTerm"]
version = "v0.3"
githubbranch = "v0.3-branch"
url = "https://v0-3.kubeflow.org"
[[params.versions]]
version = "v0.2"
githubbranch = "v0.2-branch"
url = "https://v0-2.kubeflow.org"

# User interface configuration
[params.ui]
Expand Down
8 changes: 2 additions & 6 deletions layouts/partials/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,8 @@
<link rel="{{ .Rel }}" type="{{ .MediaType.Type }}" href="{{ .Permalink | safeURL }}">
{{ end -}}

{{ $outputFormat := partial "outputformat.html" . -}}
{{ if and hugo.IsProduction (ne $outputFormat "print") -}}
<meta name="robots" content="index, follow">
{{ else -}}
<meta name="robots" content="noindex, nofollow">
{{ end -}}
<!-- Prevent search engines from indexing this old site -->
<meta name="robots" content="noindex">

<!-- include our custom Kubeflow "seo_schema" partial -->
{{ partial "seo_schema" . }}
Expand Down
33 changes: 33 additions & 0 deletions layouts/partials/version-banner.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!-- Check the variable that indicates whether this is an archived doc set. If yes, display a banner. -->
{{- $latest_version_url := .Site.Params.url_latest_version }}
{{- $current_version := replace .Site.Params.version "v" "" | markdownify }}
{{- if .Site.Params.archived_version }}
<style>
.version-banner {
padding: 1.5rem;
margin: 2rem 0;
max-width: 40rem;
border-style: solid;
border-color: #f0ad4e;
background-color: #faf5b6;
border-radius: 0.25rem;
}
.version-banner h3 {
margin-top: 0;
margin-bottom: 0.6em;
font-size: 1.25em;
}
.version-banner p {
margin-top: 0;
margin-bottom: 0;
}
</style>
<div class="version-banner">
<h3>You are viewing documentation for <strong>Kubeflow {{ $current_version }}</strong></h3>
<p>
This is a static snapshot from the time of the Kubeflow {{ $current_version }} release.
<br>
For up-to-date information, see the <a href="{{ $latest_version_url | safeURL }}">latest version</a>.
</p>
</div>
{{- end }}

0 comments on commit 5775eb0

Please sign in to comment.