docs.adobe.comlinks to point to
typemetadata values as appropriate to improve search filter experience.
activate-exlJenkins job or you can configure your repo to auto-activate.
The Experience League UX team makes changes that we need to account for. For example, the UX team has a new landing page design, breadcrumbs, and a different search experience with filters.
landing-pages.enrepo. Feel free to edit and submit a PR. The Readme file in that repo explains landing page syntax, which is slightly different from the Markdown syntax we use in articles.
user-guide-description, which are used in landing pages and search filters. We’ll continue to add more metadata. You should review this
typemetadata in your repo to improve the search experience. See Metadata.
The Experience League team uses a different rendering tool to output Markdown as HTML. For certain elements such as code blocks and native Markdown tables, the output should improve significantly. However, we might need to do some syntax cleanup work to improve output quality. Here are examples.
Balanced HTML tables
For example, in our AEM system, HTML tables display with equal column widths regardless of the amount of content in each cell. In the new EXL system, column width is determined by the amount of content. If you used HTML tables specifically to create balanced columns, you might need to change your approach.
Look through pages in staged Experience League content to make sure everything is OK.
Code blocks are rendered with syntax highlighting in Experience League. Add a language to code blocks to take advantage of this feature.
See the githubusercontent file for a list of valid languages.
In addition, code block syntax needs to be a little cleaner for EXL validation:
Experience League requires stricter syntax for note, important, tip, and other “adornment” components than docs.adobe.com. Specifically, you’re no longer allowed to add a space between
>[!NOTE] should on its own line. The
> characters should have the same indent level. Use the format:
>[!NOTE] > >This is a note.
<!-- to start a comment and
--> to end a comment.
Do not use
<!--> to start or end a comment, or validation will fail.
Loc tags in links
[!UICONTROL] tags used in hyperlink text, use the following format:
We updated all instances of the previous format that used only one set of brackets.
>[!NOTE] This is a note.
>[!FAQ]are flagged as errors.
>characters must have the same indentation.
[ ](not checked in code blocks)
If you find more examples, please add them.
The old system converts Markdown to DITA so that it can be uploaded to AEM. We then activate the content in AEM when we’re ready.
In the new system, we’ll create a package of the repo and upload it for preview. See Publish.
Check content rendering
If you see a problem that you can’t fix, log a UGP JIRA issue.
Update links from
docs.adobe.com will be redirected to EXL, but it’s a good idea edit your links to point directly to the appropriate EXL link.
search for (click Use Regular Expressions icon):
type metadata values
Users can filter content by content type and solution (products). In this example, a search for ‘integration’ shows content for all solutions. However, users can click a product to limit the search.
In this example, you might want to edit the article about integrating Campaign with Analytics so that the
solution metadata includes both Campaign and Analytics:
solution: Campaign, Analytics
Learn how to activate content
You can use the
activate-exl Jenkins job to activate content. You can also configure your repo to auto-activate.