This document describes how to get started publishing to Experience League. Learn the high-level steps and where to go for answers about setting up your authoring environment and making your new documentation publicly available.
Budget commitments for localization might be required before deciding to publish to Experience League. The following steps familiarizes you with the decisions you will make prior to starting the authoring, migration, and publishing process.
To set up your authoring environment
Get your project approved by meeting with:
Work with ExL Engineering to migrate your content (create the destination git repository, hook up validation). (
If applicable, upload videos to Media Publishing Cloud (MPC).
Add localization tags (UICONTROL, DNL). (Contact Blake Frei)
Add metadata tags for SEO and content measurement.
Provide product terminology and translation memories for localization.
Add product term database to Acrolinx.
Prepare to publish (content clean-up, soft launch, and so on).
Do not publish English content until the following conditions are met:
Experience League currently publishes in all the following languages (no exceptions):
If you require languages that are not currently supported, your product team is responsible for providing budget to add full language support to the platform. This can include items such as:
Setting up new language support is time consuming and can affect your release dates, depending on availability of machine translation engines, etc.
ExL content is machine-translated (MT) first. Meaning, all pages are localized using MT, then human translation can be done afterwards (based on budget). If your product is new, the localization group requires a list of terminology, including localization terms and any available translation memories. See Adobe’s machine translation wiki for more information.
Machine translated pages have a widget that allows users to display the original English content. Because the MT process is much quicker than human translation, it is likely that pages that frequently change are shown as machine-translated pages.
Not every language supported by the product has a custom MT engine on the market. All new customization requests must be discussed with the Globalization team. The Globalization team needs at least three months lead time to get an MT engine set up and customized. The budget to customize the engine(s) may need to be provided by the product team.
The cost of customizing an engine can vary greatly depending on the target language, available resources, and available training material.
This checklist assumes that you’ve created a new repository in git and have authored your pages in markdown and that you are ready to make your content available.
Before your project goes live, complete the steps described above and provide a lead time of at least two (2) weeks in advance.
After you migrate or create content, the following tasks are required to make your documentation available for the first time:
If your project is coming from a migration, you need to clean up the migrated content, ensuring that it passes validation before publishing your content set. Contact the Bob Bringhurst for information on the steps needed to clean up your repository in a migration.
Before you perform a soft launch, ensure that you do the following:
(home.md)to your guide. Your guide must have an introductory page. This should be the first article in your
TOC.mdfile. In user guides, this file includes a summary of the solution and user guide, links to other solution user guides (if applicable), and links to useful resources such as community and learning resources.
nso Google cannot find the pages when you publish them. (You’ll want to change this to
ylater a day or so prior to hard launch.)
A soft launch means publishing your content on the production server (
experienceleague.adobe.com) without indexing it in Google. You can only do this after your content is validated in Jenkins and you can preview in
activate-exljob in Jenkins.) Be sure your index is set to
experienceleague.corp.adobe.comand continue clean-up.
productmetadata item for your product in either the
metadata.mdfile so that analytics can start running on your content. Add
typemetadata so that your content can be filtered in search. the See Metadata for valid values.
metadata.md) to change the header links to point to appropriate content for hub page, getting started, and tutorials.
Preparing for go live can take up to two weeks if you are redirecting from helpx. If you have no redirects, this can take considerably less time.
This is the day that material goes live.
Although some of the activities after the initial go live are self-explanatory, such as cleaning up any errors or fixing any links to pages you missed, a few are specific to documents that are in our system:
After your content is live, editing and publishing is straightforward if you understand Git Hub and Markdown. Generally, the authoring and editing process is as follows: