Landing pages

The landing pages are generated based on the markdown files in the landing-pages.en repo. Note the following:

  • Landing pages markdown syntax rules are different from other AdobeDocs repos.
  • Validation rules for landing pages are different from other AdobeDocs repos.
  • Preview and manual activation for landing pages is not available.
IMPORTANT

Before you update landing pages, please contact Bob.

Linking syntax

Use this syntax when linking to a guide or tutorial.

+ [Title](<repo-name-no-language>#<toc-anchor>)

Examples:

+ [Analytics Media Guide](analytics-media#using)

+ [Analytics Tutorials](analytics-learn#tutorials)

+ [Article title](<repo-name-no-language>#/<git-relative-path><filename.md>)

Example:

+ [AEM 6.5 Release Notes](experience-manager-65#/help/release-notes/home.md)

Example:

+ [Admin Guide](https://helpx.adobe.com/enterprise/admin-guide.html)

Heading anchors

The anchors in a heading, such as ## Guides {#lists-documentation} help determine which CSS design element is used for that section.

{#template-class} is the format.

  • For template, we support either lists or tiles.
  • For class, use a string to specify the section, such as documentation (guides), tutorials, release, or resources.

Note that there is also a tier value based on the filename: home.md is one tier, a filename with -tutorials is another tier, and all other files are in another tier. Tiers are part of the design consideration.

How descriptions are generated

When we link to a guide…

When a guide is linked to (<repo-name>#<toc-anchor>), we fetch the description from the user-guide-description field in the TOC.md file.

When we link to an article…

When an article is linked to (<repo-name>#/<root-git-path/article-name.md>), we fetch the description from the landing-page-description field in the article if it exists or the description if it does not exist.

When we use an external link…

We add a description directly after the link, on the same line followed by a space.

Turn on or off descriptions

Use {descriptions=off} or {descriptions=on} (no #) to turn on or off description display.

If descriptions are turned on, we fetch the description from the user-guide-description value in the target TOC.md file for a guide link, or from the description value in the target article if an article is linked to.

You can type a description in the landing page to override the description. This is especially useful for links to external sites.

Example:

+ [Admin Guide](https://helpx.adobe.com/enterprise/admin-guide.html) Use the Admin Guide to administer users and products.

Use description overrides sparingly. These descriptions are not localized.

The following metadata is used only in landing-pages.en.

  • breadcrumb-name: is the text that appears in the breadcrumb.

  • child-repos: is the list all the repos that use this landing page for its breadcrumbs. A repo can be assigned only to one (1) landing page. That’s because each article can have only one breadcrumb. However, note that a link to a guide or tutorial can appear on multiple landing pages.

    If a repo is not listed in any landing page as a child repo, the default breadcrumb uses the Home page.

  • parent-landing-page: is used only if there are multiple landing pages. Currently, we use this only for the experience-manager-tutorials landing page.

On this page