Skip to content

Commit

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

Signed-off-by: Mathew Wicks <[email protected]>

* Update Hugo to 0.81.0

Signed-off-by: Mathew Wicks <[email protected]>

* Add missing `package.json` for Netlify

Signed-off-by: Mathew Wicks <[email protected]>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <[email protected]>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <[email protected]>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

---------

Signed-off-by: Mathew Wicks <[email protected]>
  • Loading branch information
thesuperzapper authored Sep 12, 2024
1 parent 98a7bc4 commit 1f1b247
Show file tree
Hide file tree
Showing 7 changed files with 66 additions and 90 deletions.
55 changes: 6 additions & 49 deletions OWNERS
Original file line number Diff line number Diff line change
@@ -1,50 +1,7 @@
approvers:
- abhi-g
- aronchick
- dansanche
- ewilderj
- jlewi
- kunmingg
- lluunn
- nickchase
- pdmack
- richardsliu
- sarahmaddox
- texasmichelle
- willingc
- dsdinter
- Ark-kun
- gaoning777
- hongye-sun
- IronPan
- neuromage
- paveldournov
- qimingj
- rileyjbauer
- vicaire
- yebrahim
reviewers:
- abhi-g
- aronchick
- dansanche
- inc0
- jlewi
- kunmingg
- lluunn
- nickchase
- pdmack
- richardsliu
- sarahmaddox
- texasmichelle
- willingc
- dsdinter
- Ark-kun
- gaoning777
- hongye-sun
- IronPan
- neuromage
- paveldournov
- qimingj
- rileyjbauer
- vicaire
- yebrahim
- andreyvelich
- james-jwu
- jbottum
- johnugeorge
- terrytangyuan
- zijianjoy
25 changes: 13 additions & 12 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ 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"'.
Expand All @@ -128,24 +128,25 @@ githubbranch = "v0.5-branch"
# Add new release versions here. 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 = "v0.2"
githubbranch = "v0.2-branch"
url = "https://v0-2.kubeflow.org"

version = "v0.5"
githubbranch = "v0.5-branch"
url = "https://v0-5.kubeflow.org"
[[params.versions]]
version = "v0.4"
githubbranch = "v0.4-branch"
url = "https://v0-4.kubeflow.org"
[[params.versions]]
version = "v0.3"
githubbranch = "v0.3-branch"
url = "https://v0-3.kubeflow.org"

[[params.versions]]
version = "v0.4"
githubbranch = "v0.4-branch"
url = "https://v0-4.kubeflow.org"
version = "v0.2"
githubbranch = "v0.2-branch"
url = "https://v0-2.kubeflow.org"

# Docsy: User interface configuration
[params.ui]
Expand Down
7 changes: 2 additions & 5 deletions layouts/partials/head.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
{{ .Hugo.Generator }}
{{ if eq (getenv "HUGO_ENV") "production" }}
<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">
{{ range .AlternativeOutputFormats -}}
<link rel="{{ .Rel }}" type="{{ .MediaType.Type }}" href="{{ .Permalink | safeURL }}">
{{ end -}}
Expand Down
2 changes: 1 addition & 1 deletion layouts/partials/navbar-version-selector.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
{{ .Site.Params.version }}
{{ .Site.Params.version_menu }}
</a>
<div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
{{ range .Site.Params.versions }}
Expand Down
53 changes: 32 additions & 21 deletions layouts/partials/version-banner.html
Original file line number Diff line number Diff line change
@@ -1,22 +1,33 @@
<!-- Check the variable that indicates whether this is an archived doc set.
If yes, display a banner. -->
{{ if .Site.Params.archived_version }}
{{ $color := "primary" }}
{{ $latest := .Site.Params.url_latest_version }}
<div style="font-weight: $font-weight-medium;
background: $gray-100;
color: inherit;
border-radius: 0;
margin: 2rem;
padding: 1.5rem;
padding-bottom: 0.5rem;
border-style: solid;
border-color: $color;">
{{ with .Site.Params.version }}<p>Version {{ . | markdownify }} of the
documentation is no longer actively maintained. The site that you are
currently viewing is an archived snapshot. For up-to-date documentation,
see the
<a href="{{ $latest | safeURL }}" target="_blank">latest version</a>.</p>
{{ end }}
<!-- 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 }}
{{- end }}
6 changes: 4 additions & 2 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
command = "hugo"

[context.deploy-preview.environment]
HUGO_VERSION = "0.51"
HUGO_VERSION = "0.81.0"
NODE_VERSION = "10"

[context.production.environment]
HUGO_VERSION = "0.51"
HUGO_VERSION = "0.81.0"
NODE_VERSION = "10"
HUGO_ENV = "production"
8 changes: 8 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "website",
"devDependencies": {
"autoprefixer": "^9.4.3",
"postcss": "^7.0.6",
"postcss-cli": "^6.1.0"
}
}

0 comments on commit 1f1b247

Please sign in to comment.