From issues-return-179551-archive-asf-public=cust-asf.ponee.io@flink.apache.org Mon Jul 23 17:30:06 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id A614C180647 for ; Mon, 23 Jul 2018 17:30:05 +0200 (CEST) Received: (qmail 36603 invoked by uid 500); 23 Jul 2018 15:30:04 -0000 Mailing-List: contact issues-help@flink.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@flink.apache.org Delivered-To: mailing list issues@flink.apache.org Received: (qmail 36594 invoked by uid 99); 23 Jul 2018 15:30:04 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 23 Jul 2018 15:30:04 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 5DEF3C7CCE for ; Mon, 23 Jul 2018 15:30:04 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -110.3 X-Spam-Level: X-Spam-Status: No, score=-110.3 tagged_above=-999 required=6.31 tests=[ENV_AND_HDR_SPF_MATCH=-0.5, KAM_SHORT=0.001, RCVD_IN_DNSWL_MED=-2.3, SPF_PASS=-0.001, USER_IN_DEF_SPF_WL=-7.5, USER_IN_WHITELIST=-100] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id eLC_pnex2W6L for ; Mon, 23 Jul 2018 15:30:03 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with ESMTP id 709E45F4E7 for ; Mon, 23 Jul 2018 15:30:02 +0000 (UTC) Received: from jira-lw-us.apache.org (unknown [207.244.88.139]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id 1F382E2567 for ; Mon, 23 Jul 2018 15:30:01 +0000 (UTC) Received: from jira-lw-us.apache.org (localhost [127.0.0.1]) by jira-lw-us.apache.org (ASF Mail Server at jira-lw-us.apache.org) with ESMTP id 800CD27144 for ; Mon, 23 Jul 2018 15:30:00 +0000 (UTC) Date: Mon, 23 Jul 2018 15:30:00 +0000 (UTC) From: "ASF GitHub Bot (JIRA)" To: issues@flink.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (FLINK-9806) Add a canonical link element to documentation HTML MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/FLINK-9806?page=3Dcom.atlassian= .jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=3D1655= 3000#comment-16553000 ]=20 ASF GitHub Bot commented on FLINK-9806: --------------------------------------- GitHub user patricklucas opened a pull request: https://github.com/apache/flink/pull/6396 [FLINK-9806][docs] Add canonical link element to docs ## What is the purpose of the change =20 Flink's documentation's SEO is a mess, with web searches often returnin= g results from many Flink versions, usually with the latest not at the top. =20 This change adds an HTML `link` tag with `rel=3D"canonical"` to indicat= e to crawlers where to find the latest version of the page, i.e. served fro= m `//ci.apache.org/projects/flink/flink-docs-stable/`. =20 ## Brief change log =20 - Update Docker image for building the docs to support the required rub= y version - Add value to the docs config file to indicate the "stable" base URL - Add a `link` element with `rel=3D"canonical"` to the base template so= each page includes it with the appropriate value =20 ## Notes =20 Once this has been merged, we should port this change to the release br= anches whose docs are still available. You can merge this pull request into a Git repository by running: $ git pull https://github.com/patricklucas/flink FLINK-9806_docs_canoni= cal_url Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/6396.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #6396 =20 ---- commit 2fec8ceafcb02d2024ab269c775418311661c9a3 Author: Patrick Lucas Date: 2018-07-23T14:24:08Z Use fedora for Docker docs build for newer Ruby =20 The docs require Ruby >=3D 2.1.0 which isn't shipped by CentOS 7. It is available in Fedora 28, however, and I don't see any harm in switching to it. commit ff42e8a65ce0304ce194d3761aad446d16667eee Author: Patrick Lucas Date: 2018-07-23T15:17:14Z Add rel=3Dcanonical link to all pages ---- > Add a canonical link element to documentation HTML > -------------------------------------------------- > > Key: FLINK-9806 > URL: https://issues.apache.org/jira/browse/FLINK-9806 > Project: Flink > Issue Type: Improvement > Components: Documentation > Affects Versions: 1.5.0 > Reporter: Patrick Lucas > Priority: Major > Labels: pull-request-available > > Flink has suffered for a while with non-optimal SEO for its documentation= , meaning a web search for a topic covered in the documentation often produ= ces results for many versions of Flink, even preferring older versions sinc= e those pages have been around for longer. > Using a canonical link element (see references) may alleviate this by inf= orming search engines about where to find the latest documentation (i.e. pa= ges hosted under [https://ci.apache.org/projects/flink/flink-docs-master/).= ] > I think this is at least worth experimenting with, and if it doesn't caus= e problems, even backporting it to the older release branches to eventually= clean up the Flink docs' SEO and=C2=A0converge on advertising only the lat= est docs (unless a specific version is specified). > References: > * [https://moz.com/learn/seo/canonicalization] > * [https://yoast.com/rel-canonical/] > * [https://support.google.com/webmasters/answer/139066?hl=3Den] > * [https://en.wikipedia.org/wiki/Canonical_link_element] -- This message was sent by Atlassian JIRA (v7.6.3#76005)