Microsites

A microsite is an HTML website that is uploaded to Experience League directly instead of through the standard authoring pipeline. Microsites are useful for displaying HTML sample files or providing tools or services not available through markdown authoring.

Examples:

Creating a microsite

  1. Create an AdobeDocs git repo that begins with microsite- (no .en suffix).

  2. Add the HTML files to the repo.

    • The main .html file (such as index.html) should be in root directory, with no other .html files on that level. This .html file is used in the URL.
    • If your microsite includes multiple .html files, put all those .html files in one or more subdirectories, and link to them from the main .html file.
    • Add all supporting CSS/JS/reference files.

    Microsite git repo

  3. Log a JIRA ticket (project = UGP; component = Authoring) with a title such as “Add microsite for <x>,” and assign it to Bob Bringhurst.

    Bob will work with you to determine the microsite URL. See image below for examples.

  4. (Admin task) Specify settings in the Microsites YAML file.

    Microsite config image

    Current top-level keys used in the URL include tools, landing, and developer. If new top-level keys are required, clone this ticket.

  5. Test the microsite.

  6. If the microsite is migrated, update links.

    • (Writer task) Update links in help articles.
    • (Admin task) Log JIRA ticket to change redirect exception (“reverse proxy”).

Adding SEO metadata to your microsite content

If you want to add description or other metadata to your microsites, use a format similar to the following sample.

<!doctype html>
<html>
  <head>
    <title>Adobe Target Sample Size Calculator</title>
    <meta name="description" content="The Adobe Target Sample Size Calculator helps you determine the sample size needed for a successful A/B test.">

Adding Analytics files to your microsite content

We can’t do this right now in an easy. Writers would need to add their own analytics tagging.

On this page