diff mbox

[v2] doc: identify asciidocs to search engines

Message ID 1453329195-10920-1-git-send-email-mike.holmes@linaro.org
State Accepted
Commit 73ffaa87f5365f81ba878449ca49120e5f3bf584
Headers show

Commit Message

Mike Holmes Jan. 20, 2016, 10:33 p.m. UTC
Search engines are not currently indexing the documentation, add a title
and description.

Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
v2:
   remove analytics

 doc/implementers-guide/implementers-guide.adoc | 7 ++++---
 doc/process-guide/release-guide.adoc           | 5 +++--
 doc/users-guide/users-guide.adoc               | 6 +++---
 3 files changed, 10 insertions(+), 8 deletions(-)

Comments

Bill Fischofer Jan. 22, 2016, 12:28 a.m. UTC | #1
On Wed, Jan 20, 2016 at 4:33 PM, Mike Holmes <mike.holmes@linaro.org> wrote:

> Search engines are not currently indexing the documentation, add a title

> and description.

>

> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>

>


Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org>


> ---

> v2:

>    remove analytics

>

>  doc/implementers-guide/implementers-guide.adoc | 7 ++++---

>  doc/process-guide/release-guide.adoc           | 5 +++--

>  doc/users-guide/users-guide.adoc               | 6 +++---

>  3 files changed, 10 insertions(+), 8 deletions(-)

>

> diff --git a/doc/implementers-guide/implementers-guide.adoc

> b/doc/implementers-guide/implementers-guide.adoc

> index eb076cf..574317a 100644

> --- a/doc/implementers-guide/implementers-guide.adoc

> +++ b/doc/implementers-guide/implementers-guide.adoc

> @@ -1,12 +1,13 @@

> -OpenDataPlane (ODP)  Implementers Guide

> -=======================================

> +:doctitle: OpenDataPlane (ODP) Implementers-Guide

> +:description: This document is intended to guide a new OpenDataPlane +

> +implementation developer.

>  :toc:

>

>  :numbered!:

>  [abstract]

>  Abstract

>  --------

> -This document is intended to guide a new ODP developer.

> +This document is intended to guide a new ODP implementation developer.

>  Further details about ODP may be found at http://opendataplane.org[ODP

> homepage]

>

>

> diff --git a/doc/process-guide/release-guide.adoc

> b/doc/process-guide/release-guide.adoc

> index 5bef890..60ef769 100644

> --- a/doc/process-guide/release-guide.adoc

> +++ b/doc/process-guide/release-guide.adoc

> @@ -1,5 +1,6 @@

> -OpenDataPlane (ODP) Release-Guide

> -=================================

> +:doctitle: OpenDataPlane (ODP) Release-Guide

> +:description: This document is intended to guide a new OpenDataPlane +

> +application developer in understanding the git work flow of the project

>  :toc:

>

>  :numbered!:

> diff --git a/doc/users-guide/users-guide.adoc

> b/doc/users-guide/users-guide.adoc

> index 542b7d1..2190c13 100644

> --- a/doc/users-guide/users-guide.adoc

> +++ b/doc/users-guide/users-guide.adoc

> @@ -1,8 +1,8 @@

> -OpenDataPlane (ODP)  Users-Guide

> -================================

> +:doctitle: OpenDataPlane (ODP) Users-Guide

> +:description: This document is intended to guide a new OpenDataPlane +

> +application developer.

>  :toc:

>

> -

>  :numbered!:

>  [abstract]

>  Abstract

> --

> 2.5.0

>

> _______________________________________________

> lng-odp mailing list

> lng-odp@lists.linaro.org

> https://lists.linaro.org/mailman/listinfo/lng-odp

>
Maxim Uvarov Jan. 22, 2016, 2:59 p.m. UTC | #2
Merged,
Maxim.

On 01/22/2016 03:28, Bill Fischofer wrote:
>
>
> On Wed, Jan 20, 2016 at 4:33 PM, Mike Holmes <mike.holmes@linaro.org 
> <mailto:mike.holmes@linaro.org>> wrote:
>
>     Search engines are not currently indexing the documentation, add a
>     title
>     and description.
>
>     Signed-off-by: Mike Holmes <mike.holmes@linaro.org
>     <mailto:mike.holmes@linaro.org>>
>
>
> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org 
> <mailto:bill.fischofer@linaro.org>>
>
>     ---
>     v2:
>        remove analytics
>
>      doc/implementers-guide/implementers-guide.adoc | 7 ++++---
>      doc/process-guide/release-guide.adoc           | 5 +++--
>      doc/users-guide/users-guide.adoc               | 6 +++---
>      3 files changed, 10 insertions(+), 8 deletions(-)
>
>     diff --git a/doc/implementers-guide/implementers-guide.adoc
>     b/doc/implementers-guide/implementers-guide.adoc
>     index eb076cf..574317a 100644
>     --- a/doc/implementers-guide/implementers-guide.adoc
>     +++ b/doc/implementers-guide/implementers-guide.adoc
>     @@ -1,12 +1,13 @@
>     -OpenDataPlane (ODP)  Implementers Guide
>     -=======================================
>     +:doctitle: OpenDataPlane (ODP) Implementers-Guide
>     +:description: This document is intended to guide a new
>     OpenDataPlane +
>     +implementation developer.
>      :toc:
>
>      :numbered!:
>      [abstract]
>      Abstract
>      --------
>     -This document is intended to guide a new ODP developer.
>     +This document is intended to guide a new ODP implementation
>     developer.
>      Further details about ODP may be found at
>     http://opendataplane.org[ODP homepage]
>
>
>     diff --git a/doc/process-guide/release-guide.adoc
>     b/doc/process-guide/release-guide.adoc
>     index 5bef890..60ef769 100644
>     --- a/doc/process-guide/release-guide.adoc
>     +++ b/doc/process-guide/release-guide.adoc
>     @@ -1,5 +1,6 @@
>     -OpenDataPlane (ODP) Release-Guide
>     -=================================
>     +:doctitle: OpenDataPlane (ODP) Release-Guide
>     +:description: This document is intended to guide a new
>     OpenDataPlane +
>     +application developer in understanding the git work flow of the
>     project
>      :toc:
>
>      :numbered!:
>     diff --git a/doc/users-guide/users-guide.adoc
>     b/doc/users-guide/users-guide.adoc
>     index 542b7d1..2190c13 100644
>     --- a/doc/users-guide/users-guide.adoc
>     +++ b/doc/users-guide/users-guide.adoc
>     @@ -1,8 +1,8 @@
>     -OpenDataPlane (ODP)  Users-Guide
>     -================================
>     +:doctitle: OpenDataPlane (ODP) Users-Guide
>     +:description: This document is intended to guide a new
>     OpenDataPlane +
>     +application developer.
>      :toc:
>
>     -
>      :numbered!:
>      [abstract]
>      Abstract
>     --
>     2.5.0
>
>     _______________________________________________
>     lng-odp mailing list
>     lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org>
>     https://lists.linaro.org/mailman/listinfo/lng-odp
>
>
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
diff mbox

Patch

diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc
index eb076cf..574317a 100644
--- a/doc/implementers-guide/implementers-guide.adoc
+++ b/doc/implementers-guide/implementers-guide.adoc
@@ -1,12 +1,13 @@ 
-OpenDataPlane (ODP)  Implementers Guide
-=======================================
+:doctitle: OpenDataPlane (ODP) Implementers-Guide
+:description: This document is intended to guide a new OpenDataPlane +
+implementation developer.
 :toc:
 
 :numbered!:
 [abstract]
 Abstract
 --------
-This document is intended to guide a new ODP developer.
+This document is intended to guide a new ODP implementation developer.
 Further details about ODP may be found at http://opendataplane.org[ODP homepage]
 
 
diff --git a/doc/process-guide/release-guide.adoc b/doc/process-guide/release-guide.adoc
index 5bef890..60ef769 100644
--- a/doc/process-guide/release-guide.adoc
+++ b/doc/process-guide/release-guide.adoc
@@ -1,5 +1,6 @@ 
-OpenDataPlane (ODP) Release-Guide
-=================================
+:doctitle: OpenDataPlane (ODP) Release-Guide
+:description: This document is intended to guide a new OpenDataPlane +
+application developer in understanding the git work flow of the project
 :toc:
 
 :numbered!:
diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc
index 542b7d1..2190c13 100644
--- a/doc/users-guide/users-guide.adoc
+++ b/doc/users-guide/users-guide.adoc
@@ -1,8 +1,8 @@ 
-OpenDataPlane (ODP)  Users-Guide
-================================
+:doctitle: OpenDataPlane (ODP) Users-Guide
+:description: This document is intended to guide a new OpenDataPlane +
+application developer.
 :toc:
 
-
 :numbered!:
 [abstract]
 Abstract