Skip to content

Commit 3ac3540

Browse files
usha-mandyausha-mandya
authored
Merge pull request docker#11594 from thaJeztah/indexing_tweaks
Updates to handling of non-indexable pages
2 parents 1c9b279 + b4f5167 commit 3ac3540

File tree

211 files changed

+300
-2084
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

211 files changed

+300
-2084
lines changed

‎404.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: "Sorry, we can't find that page"
33
permalink: /404.html
44
noratings: true
55
notoc: true
6+
sitemap: false
67
skip_read_time: true
78
---
89

‎README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,8 @@ following keys are supported. The title, description, and keywords are required.
217217
| toc_max | no | Ignored if `notoc` is set to `false`. The maximum heading level included in the in-page TOC. Defaults to `3`, to show `<h3>` headings. Set to the same as `toc_min` to only show `toc_min` level of headings. |
218218
| tree | no | Either `true` or `false`. Set to `false` to disable the left-hand site-wide navigation for this page. Appropriate for some pages like the search page or the 404 page. |
219219
| no_ratings | no | Either `true` or `false`. Set to `true` to disable the page-ratings applet for this page. Defaults to `false`. |
220-
| skip_read_time | no | Set to `true` to disable the 'Estimated reading time' banner for this page. |
220+
| skip_read_time | no | Set to `true` to disable the 'Estimated reading time' banner for this page. |
221+
| sitemap | no | Exclude the page from indexing by search engines. When set to `false`, the page is excluded from `sitemap.xml`, and a `<meta name="robots" content="noindex"/>` header is added to the page. |
221222
222223
The following is an example of valid (but contrived) page metadata. The order of
223224
the metadata elements in the front-matter is not important.

‎_config.yml

+14-2
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,25 @@ defaults:
9797
- scope:
9898
path: "datacenter"
9999
values:
100-
hide_from_sitemap: true
100+
sitemap: false
101101
title: Docker Enterprise moved to Mirantis
102+
- scope:
103+
path: "desktop/enterprise"
104+
values:
105+
sitemap: false
102106
- scope:
103107
path: "ee"
104108
values:
105-
hide_from_sitemap: true
109+
sitemap: false
106110
title: Docker Enterprise moved to Mirantis
111+
- scope:
112+
path: "machine"
113+
values:
114+
sitemap: false
115+
- scope:
116+
path: "samples/library"
117+
values:
118+
sitemap: false
107119

108120
# Assets
109121
#

‎_config_authoring.yml

+14-2
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,25 @@ defaults:
9494
- scope:
9595
path: "datacenter"
9696
values:
97-
hide_from_sitemap: true
97+
sitemap: false
9898
title: Docker Enterprise moved to Mirantis
99+
- scope:
100+
path: "desktop/enterprise"
101+
values:
102+
sitemap: false
99103
- scope:
100104
path: "ee"
101105
values:
102-
hide_from_sitemap: true
106+
sitemap: false
103107
title: Docker Enterprise moved to Mirantis
108+
- scope:
109+
path: "machine"
110+
values:
111+
sitemap: false
112+
- scope:
113+
path: "samples/library"
114+
values:
115+
sitemap: false
104116

105117
# Assets
106118
#

‎_data/toc.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1340,7 +1340,7 @@ manuals:
13401340
section:
13411341
- sectiontitle: Docker Machine
13421342
section:
1343-
- path: /machine/overview/
1343+
- path: /machine/
13441344
title: Machine overview
13451345
- path: /machine/install-machine/
13461346
title: Install Machine

‎_includes/head.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@
2626
{%- endif -%}
2727
<head>
2828
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
29-
{%- if site.google_analytics != '' -%}{%- include analytics/google_analytics.html GOOGLE_ID=site.google_analytics -%}{%- endif -%}
30-
{%- if page.hide_from_sitemap or site.GH_ENV == "gh_pages" %}
29+
{%- if page.sitemap == false or site.GH_ENV == "gh_pages" %}
3130
<meta name="robots" content="noindex"/>
3231
{%- endif %}
32+
{%- if site.google_analytics != '' -%}{%- include analytics/google_analytics.html GOOGLE_ID=site.google_analytics -%}{%- endif -%}
3333
<title>{{ page.title | default: page_title }} | Docker Documentation</title>
3434
<meta name="description" content="{{ page.description | default: page_description | escape}}" />
3535
<meta name="keywords" content="{{ page.keywords | default: 'docker, docker open source, docker platform, distributed applications, microservices, containers, docker containers, docker software, docker virtualization' }}">

‎_includes/library-samples.md

-8
This file was deleted.

‎_layouts/redirect.html

+9-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,15 @@
22
<html lang="en-US">
33
<meta charset="utf-8">
44
<title>Redirecting&hellip;</title>
5-
<link rel="canonical" href="https://docs.docker.com{{ page.redirect.to }}">
6-
<meta http-equiv="refresh" content="0; url={{ page.redirect.to }}">
5+
{%- assign redirect_to = page.redirect.to | remove_first: 'https://docs.docker.com' | remove_first: 'http://docs.docker.com' %}
6+
{%- if redirect_to contains "://" %}
7+
<link rel="canonical" href="{{ redirect_to }}">
8+
{%- else %}
9+
<link rel="canonical" href="https://docs.docker.com{{ redirect_to }}">
10+
{%- endif %}
11+
<meta http-equiv="refresh" content="0; url={{ redirect_to }}">
712
<meta name="robots" content="noindex">
813
<h1>Redirecting&hellip;</h1>
9-
<a href="{{ page.redirect.to }}">Click here if you are not redirected.</a>
10-
<script>location="{{ page.redirect.to }}"</script>
14+
<a href="{{ redirect_to }}">Click here if you are not redirected.</a>
15+
<script>location="{{ redirect_to }}"</script>
1116
</html>

‎_samples/library/adminer.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: adminer
3-
keywords: library, sample, adminer
4-
repo: adminer
5-
layout: docs
6-
permalink: /samples/library/adminer/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/adminer/
83
redirect_from:
94
- /samples/adminer/
10-
description: |
11-
Database management in a single PHP file.
125
---
13-
14-
Database management in a single PHP file.
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/adoptopenjdk.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: adoptopenjdk
3-
keywords: library, sample, adoptopenjdk
4-
repo: adoptopenjdk
5-
layout: docs
6-
permalink: /samples/library/adoptopenjdk/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/adoptopenjdk/
83
redirect_from:
94
- /samples/adoptopenjdk/
10-
description: |
11-
Official Images for OpenJDK + HotSpot and OpenJDK + Eclipse OpenJ9 binaries built by AdoptOpenJDK.
125
---
13-
14-
Official Images for OpenJDK + HotSpot and OpenJDK + Eclipse OpenJ9 binaries built by AdoptOpenJDK.
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/aerospike.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: aerospike
3-
keywords: library, sample, aerospike
4-
repo: aerospike
5-
layout: docs
6-
permalink: /samples/library/aerospike/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/aerospike/
83
redirect_from:
94
- /samples/aerospike/
10-
description: |
11-
Aerospike – the reliable, high performance, distributed database optimized for flash and RAM.
125
---
13-
14-
Aerospike – the reliable, high performance, distributed database optimized for flash and RAM.
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/alpine.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: alpine
3-
keywords: library, sample, alpine
4-
repo: alpine
5-
layout: docs
6-
permalink: /samples/library/alpine/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/alpine/
83
redirect_from:
94
- /samples/alpine/
10-
description: |
11-
A minimal Docker image based on Alpine Linux with a complete package index and only 5 MB in size!
125
---
13-
14-
A minimal Docker image based on Alpine Linux with a complete package index and only 5 MB in size!
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/alt.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: alt
3-
keywords: library, sample, alt
4-
repo: alt
5-
layout: docs
6-
permalink: /samples/library/alt/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/alt/
83
redirect_from:
94
- /samples/alt/
10-
description: |
11-
The official build of ALT Linux.
125
---
13-
14-
The official build of ALT Linux.
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/amazoncorretto.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: amazoncorretto
3-
keywords: library, sample, amazoncorretto
4-
repo: amazoncorretto
5-
layout: docs
6-
permalink: /samples/library/amazoncorretto/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/amazoncorretto/
83
redirect_from:
94
- /samples/amazoncorretto/
10-
description: |
11-
Corretto is a no-cost, production-ready distribution of the Open Java Development Kit (OpenJDK).
125
---
13-
14-
Corretto is a no-cost, production-ready distribution of the Open Java Development Kit (OpenJDK).
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/amazonlinux.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: amazonlinux
3-
keywords: library, sample, amazonlinux
4-
repo: amazonlinux
5-
layout: docs
6-
permalink: /samples/library/amazonlinux/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/amazonlinux/
83
redirect_from:
94
- /samples/amazonlinux/
10-
description: |
11-
Amazon Linux provides a stable, secure, and high-performance execution environment for applications.
125
---
13-
14-
Amazon Linux provides a stable, secure, and high-performance execution environment for applications.
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/arangodb.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: arangodb
3-
keywords: library, sample, arangodb
4-
repo: arangodb
5-
layout: docs
6-
permalink: /samples/library/arangodb/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/arangodb/
83
redirect_from:
94
- /samples/arangodb/
10-
description: |
11-
ArangoDB - a distributed database with a flexible data model for documents, graphs, and key-values.
125
---
13-
14-
ArangoDB - a distributed database with a flexible data model for documents, graphs, and key-values.
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/backdrop.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: backdrop
3-
keywords: library, sample, backdrop
4-
repo: backdrop
5-
layout: docs
6-
permalink: /samples/library/backdrop/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/backdrop/
83
redirect_from:
94
- /samples/backdrop/
10-
description: |
11-
The comprehensive CMS for small to medium sized businesses and non-profits.
125
---
13-
14-
The comprehensive CMS for small to medium sized businesses and non-profits.
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/bash.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: bash
3-
keywords: library, sample, bash
4-
repo: bash
5-
layout: docs
6-
permalink: /samples/library/bash/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/bash/
83
redirect_from:
94
- /samples/bash/
10-
description: |
11-
Bash is the GNU Project's Bourne Again SHell
125
---
13-
14-
Bash is the GNU Project's Bourne Again SHell
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/bonita.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: bonita
3-
keywords: library, sample, bonita
4-
repo: bonita
5-
layout: docs
6-
permalink: /samples/library/bonita/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/bonita/
83
redirect_from:
94
- /samples/bonita/
10-
description: |
11-
Bonita is an open-source business process management and workflow suite
125
---
13-
14-
Bonita is an open-source business process management and workflow suite
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/buildpack-deps.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: buildpack-deps
3-
keywords: library, sample, buildpack-deps
4-
repo: buildpack-deps
5-
layout: docs
6-
permalink: /samples/library/buildpack-deps/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/buildpack-deps/
83
redirect_from:
94
- /samples/buildpack-deps/
10-
description: |
11-
A collection of common build dependencies used for installing various modules, e.g., gems.
125
---
13-
14-
A collection of common build dependencies used for installing various modules, e.g., gems.
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/busybox.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: busybox
3-
keywords: library, sample, busybox
4-
repo: busybox
5-
layout: docs
6-
permalink: /samples/library/busybox/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/busybox/
83
redirect_from:
94
- /samples/busybox/
10-
description: |
11-
Busybox base image.
125
---
13-
14-
Busybox base image.
15-
16-
17-
{% include library-samples.md %}

‎_samples/library/cassandra.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
---
2-
title: cassandra
3-
keywords: library, sample, cassandra
4-
repo: cassandra
5-
layout: docs
6-
permalink: /samples/library/cassandra/
7-
hide_from_sitemap: true
2+
redirect_to: https://hub.docker.com/_/cassandra/
83
redirect_from:
94
- /samples/cassandra/
10-
description: |
11-
Apache Cassandra is an open-source distributed storage system.
125
---
13-
14-
Apache Cassandra is an open-source distributed storage system.
15-
16-
17-
{% include library-samples.md %}

0 commit comments

Comments
 (0)