documentation: Simplify layerindex and layer links

(From yocto-docs rev: b157d57cc50b0a9cfaa062fa0e966b4d29eceeec)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

documentation/conf.py

@@ -80,6 +80,8 @@ extlinks = {
     'oe_lists': ('https://lists.openembedded.org%s', None),
     'oe_git': ('https://git.openembedded.org%s', None),
     'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
+    'oe_layerindex': ('https://layers.openembedded.org%s', None),
+    'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
 }
 
 # Intersphinx config to use cross reference with Bitbake user manual

documentation/dev-manual/common-tasks.rst

@@ -38,9 +38,8 @@ Follow these general steps to create your layer without using tools:
 
 1. *Check Existing Layers:* Before creating a new layer, you should be
    sure someone has not already created a layer containing the Metadata
-   you need. You can see the `OpenEmbedded Metadata
+   you need. You can see the :oe_layerindex:`OpenEmbedded Metadata Index <>`
-   Index <https://layers.openembedded.org/layerindex/layers/>`__ for a
+   for a list of layers from the OpenEmbedded community that can be used in
-   list of layers from the OpenEmbedded community that can be used in
    the Yocto Project. You could find a layer that is identical or close
    to what you need.
 
@@ -1194,8 +1193,8 @@ Before writing a recipe from scratch, it is often useful to discover
 whether someone else has already written one that meets (or comes close
 to meeting) your needs. The Yocto Project and OpenEmbedded communities
 maintain many recipes that might be candidates for what you are doing.
-You can find a good central index of these recipes in the `OpenEmbedded
+You can find a good central index of these recipes in the
-Layer Index <https://layers.openembedded.org>`__.
+:oe_layerindex:`OpenEmbedded Layer Index <>`.
 
 Working from an existing recipe or a skeleton recipe is the best way to
 get started. Here are some points on both methods:

documentation/overview-manual/concepts.rst

@@ -144,8 +144,7 @@ several pieces of hardware.
 Many layers exist that work in the Yocto Project development
 environment. The `Yocto Project Curated Layer
 Index <https://www.yoctoproject.org/software-overview/layers/>`__
-and `OpenEmbedded Layer
+and :oe_layerindex:`OpenEmbedded Layer Index <>`
-Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__
 both contain layers from which you can use or leverage.
 
 By convention, layers in the Yocto Project follow a specific form.
@@ -380,13 +379,11 @@ figure <#general-workflow-figure>`__:
 
 -  *Metadata (.bb + Patches):* Software layers containing
    user-supplied recipe files, patches, and append files. A good example
-   of a software layer might be the
+   of a software layer might be the :oe_layer:`meta-qt5 layer </meta-qt5>`
-   `meta-qt5 layer <https://github.com/meta-qt5/meta-qt5>`__ from
+   from the :oe_layerindex:`OpenEmbedded Layer Index <>`. This layer is for
-   the `OpenEmbedded Layer
+   version 5.0 of the popular `Qt <https://wiki.qt.io/About_Qt>`__
-   Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__.
+   cross-platform application development framework for desktop, embedded and
-   This layer is for version 5.0 of the popular
+   mobile.
-   `Qt <https://wiki.qt.io/About_Qt>`__ cross-platform application
-   development framework for desktop, embedded and mobile.
 
 -  *Machine BSP Configuration:* Board Support Package (BSP) layers (i.e.
    "BSP Layer" in the following figure) providing machine-specific

documentation/overview-manual/yp-intro.rst

@@ -221,8 +221,7 @@ your Metadata, the easier it is to cope with future changes.
 
    -  Familiarize yourself with the `Yocto Project curated layer
       index <https://www.yoctoproject.org/software-overview/layers/>`__
-      or the `OpenEmbedded layer
+      or the :oe_layerindex:`OpenEmbedded layer index <>`.
-      index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__.
       The latter contains more layers but they are less universally
       validated.
 
@@ -364,8 +363,7 @@ activities using the Yocto Project:
    versions available for Yocto Project. The main purpose of the system
    is to help you manage the recipes you maintain and to offer a dynamic
    overview of the project. The Recipe Reporting System is built on top
-   of the `OpenEmbedded Layer
+   of the :oe_layerindex:`OpenEmbedded Layer Index <>`, which
-   Index <http://layers.openembedded.org/layerindex/layers/>`__, which
    is a website that indexes OpenEmbedded-Core layers.
 
 -  *Patchwork:* `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__

documentation/ref-manual/migration-2.3.rst

@@ -238,7 +238,7 @@ to substitute a GPLv2 version of a GPLv3 recipe, then you must add the
 .. note::
 
    You can ``find meta-gplv2`` layer in the OpenEmbedded layer index at
-   https://layers.openembedded.org/layerindex/branch/master/layer/meta-gplv2/.
+   :oe_layer:`/meta-gplv2`.
 
 These relocated GPLv2 recipes do not receive the same level of
 maintenance as other core recipes. The recipes do not get security fixes

documentation/toaster-manual/intro.rst

@@ -27,7 +27,7 @@ extensive information about the build process.
    -  Browse layers listed in the various
       :ref:`layer sources <toaster-manual/reference:layer source>`
       that are available in your project (e.g. the OpenEmbedded Layer Index at
-      http://layers.openembedded.org/layerindex/).
+      :oe_layerindex:`/`).
 
    -  Browse images, recipes, and machines provided by those layers.
 

documentation/toaster-manual/reference.rst

@@ -24,7 +24,7 @@ type of layer source called a "layer index."
 A layer index is a web application that contains information about a set
 of custom layers. A good example of an existing layer index is the
 OpenEmbedded Layer Index. A public instance of this layer index exists
-at http://layers.openembedded.org. You can find the code for this
+at :oe_layerindex:`/`. You can find the code for this
 layer index's web application at :yocto_git:`/layerindex-web/`.
 
 When you tie a layer source into Toaster, it can query the layer source
@@ -81,7 +81,7 @@ describes two methods by which you can configure and use your layer
 index.
 
 In the previous section, the code for the OpenEmbedded Metadata Index
-(i.e. http://layers.openembedded.org) was referenced. You can use
+(i.e. :oe_layerindex:`/`) was referenced. You can use
 this code, which is at :yocto_git:`/layerindex-web/`, as a base to create
 your own layer index.
 

documentation/toaster-manual/setup-and-use.rst

@@ -462,9 +462,8 @@ Using the Toaster Web Interface
 
 The Toaster web interface allows you to do the following:
 
--  Browse published layers in the `OpenEmbedded Layer
+-  Browse published layers in the :oe_layerindex:`OpenEmbedded Layer Index <>`
-   Index <http://layers.openembedded.org>`__ that are available for your
+   that are available for your selected version of the build system.
-   selected version of the build system.
 
 -  Import your own layers for building.
 
@@ -573,11 +572,11 @@ However, the "Local Yocto Project" release will not provide you with any
 compatible layers, other than the three core layers that come with the
 Yocto Project:
 
--  `openembedded-core <http://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/>`__
+-  :oe_layer:`openembedded-core </openembedded-core>`
 
--  `meta-poky <http://layers.openembedded.org/layerindex/branch/master/layer/meta-poky/>`__
+-  :oe_layer:`meta-poky </meta-poky>`
 
--  `meta-yocto-bsp <http://layers.openembedded.org/layerindex/branch/master/layer/meta-yocto-bsp/>`__
+-  :oe_layer:`meta-yocto-bsp </meta-yocto-bsp>`
 
 .. image:: figures/compatible-layers.png
    :align: center

documentation/transitioning-to-a-custom-environment.rst

@@ -29,8 +29,8 @@ Transitioning to a custom environment for systems development
 
 #. **Find and acquire the best BSP for your target**.
    Use the :yocto_home:`Yocto Project curated layer index
-   </software-overview/layers/>` or even the `OpenEmbedded layer index
+   </software-overview/layers/>` or even the :oe_layerindex:`OpenEmbedded
-   <https://layers.openembedded.org>`_ to find and acquire the best BSP for your
+   layer index <>` to find and acquire the best BSP for your
    target board. The Yocto Project layer index BSPs are regularly validated. The
    best place to get your first BSP is from your silicon manufacturer or board
    vendor – they can point you to their most qualified efforts. In general, for

documentation/what-i-wish-id-known.rst

@@ -27,11 +27,10 @@ contact us with other suggestions.
    to be responsible for your own updates.
 
 #. **Get to know the layer index:**
-   All layers can be found in the `layer index
+   All layers can be found in the :oe_layerindex:`layer index <>`. Layers which
-   <https://layers.openembedded.org/>`_. Layers which have applied for Yocto
+   have applied for Yocto Project Compatible status (structure continuity
-   Project Compatible status (structure continuity assurance and testing) can be
+   assurance and testing) can be found in the :yocto_home:`Yocto Project Compatible index
-   found in the :yocto_home:`Yocto Project Compatible index
+   </software-over/layer/>`. Generally check the Compatible layer index first,
-   </software-over/layer/>`.  Generally check the Compatible layer index first,
    and if you don't find the necessary layer check the general layer index. The
    layer index is an original artifact from the Open Embedded Project. As such,
    that index doesn't have the curating and testing that the Yocto Project
@@ -172,7 +171,7 @@ contact us with other suggestions.
    * add an ssh server to an image (enable transferring of files to target)
    * know the anatomy of a recipe
    * know how to create and use layers
-   * find recipes (with the `OpenEmbedded Layer index <https://layers.openembedded.org>`_)
+   * find recipes (with the :oe_layerindex:`OpenEmbedded Layer index <>`)
    * understand difference between machine and distro settings
    * find and use the right BSP (machine) for your hardware
    * find examples of distro features and know where to set them