What’s new in this authoring guide

This page provides information about the latest additions to this guide. Minor updates not included.

February 2023

• Updates to get started authoring topics (ongoing)
• Release of multiple new features Feb 4-6. Info

January 2023

• New section on obtaining a list of URLs for your repo. This is especially useful for when you make lots of changes the TOC.md file and need redirect URLs.
• Feb. 6 release Badges
• Feb. 6 release Click-to-zoom images
• Added guidance for screenshots and diagrams
• Updated capitalization guidance

November 2022

• New feature: Shade boxes
• New feature: Tabs
• New feature: Image resizing and aligning
• Created videos for Working with public mirrors and Copying pull requests from public mirror to corp.

September 2022

• Adding line numbering and highlighting to code blocks.
• Added instructions for setting up a webhook to auto-create JIRA tickets whenever users log issues or submit PRs using the public mirror. Contact us if you want to enable this workflow.
• Added instructions for writers to create jira tickets for logging bugs or enhancement requests for the EXL team.
• Updated style guidelines with quick links and best practices on information design.

August 2022

• Maximum file size for images and download files is 100 MB (the github.com limit). Documented in syntax style guide.
• Support for yellow highlighting. Used by the Workfront team to preview upcoming features.
• Updated Title and Description metadata guidance.
• Updated style guidelines with best practice tips on information design.
• Updated What you should know about metadata to help clarify important points about metadata.

July 2022

• Added an example for the description (metadata) you can use on a home page. (See Descriptions.)
• Streamlined the definitions of guide and tutorial. (See Content types in Experience League documentation.)

May 2022

• Instructions for editing solution values.

April 2022

• Added guidance for Alt-text authoring in Markdown.

March 2022

• Redirects processing now runs every two hours (every even hour, Pacific Time) instead of once a day.
• Added content type examples (from AEP) in Content types.

February 2022

• Line numbering in code blocks - Use this format to add line numbering in fenced code blocks: ```html {.line-numbers}
• Includes and snippets for sharing content within a repo
• Collapsible sections (accordions)
• Added guidance on names for integrations
• New getting started pages for different authors (documentation, tutorials, intermittent) in progress.

January 2022

• Updated the Video page (MPC video process, general edits). KT/MPC experts, please send feedback to Blake.

December 2021

• Fully revamped the Metadata page.

November 2021

• You can now easily rename the Git default branch (archived: rename-git-branch.md) from master to main.
• Run a quick job to remove all unused assets from your repo.
• Added Gender and inclusive terminology as dedicated page to the topic.
• Updates to Heading names and page titles. Added examples of all types of headings for tutorials and product docs, defined types of headings (overview, introduction, fundamentals of…, get started with…)

October 2021

• Added information about creating sub-steps in Steps and lists.

September 2021

• Updated guidance in Cleanup Tasks article. Please take a look at that article.
• Updated documentation to explain that !UICONTROL and !DNL syntax can be added to HTML tables and code blocks. The pipeline strips out these UICONTROL/DNL tags during packaging for publication.
• Can’t find what you’re looking for in this guide? We still can’t search within this guide, but the home page now has a list of articles and description/keywords. Press Cmd+F on that page to search for the term you’re looking for. Still not ideal, but maybe this helps. Feel free to edit that page with more keywords.
• Documentation about creating contextual help popovers in product pages.

August 2021

• Instructions for viewing broken external links and excluding URLs from being checked.
• The Adobe Markdown Authoring extension is now available in the VSC Marketplace. See Adobe Markdown Authoring extension for VSC.

July 2021

• View this auto-updated report for a list of broken or problematic external links in your repo.
• Created Get started publishing to Experience League (formerly, New Publication Checklist). Covers onboarding tasks for new projects and authors.

June 2021

• Added Tips for improving your writing clarity
• Updates to Headings and page titles
• (Now live) Use mini-toc-levels metadata to determine how many levels of headings are displayed in the right nav. The default number of levels is 2. You can specify 1-6 levels. Levels are now indented properly in the left nav. See Metadata.
• Added guidance for writing procedures. See Steps and lists.
• You can create links that open in a new tab.
• Microsites are now available for uploading HTML files to EXL without using the markdown authoring pipeline.
• Updated Clean-up Tasks.

May 2021

• Updated Acrolinx regarding the Visual Studio extension.
• Updated Jenkins validation, staging reviews, and other articles to reflect new post-migration capabilities, including Slack notifications.

April 2021

• New review branch is currently being tested for repos that are using the new version of Jenkins.
• Art of the TOC - Rewrote guidance on tables of contents.
• Metadata - Full rewrite to metadata, tagging, yaml locations, and more.

March 2021

• New table formatting option - Lets you use special syntax ({style="table-layout:auto"}) to change how a table is rendered. Auto used git-flavored markdown rendering. Fixed uses the current rendering method.
• Content types - Definitions of deliverable types and overview, concepts, tasks, and so on.
• New Jenkins instance for testing
• Headings for concepts, tasks, and page titles - New guidance for authoring headings.
• New project checklist - Get started publishing to Experience League
• Acrolinx - Updates to the extension setup.
• Metadata - Updates to tagging, yaml locations, and more.

February 2021

• Hiding content updates.
• Acrolinx progress.
• Metadata updates.

January 2021

• Updated metadata guidance for title and description to improve SEO. We’re also rolling out new feature, topic, role, and level metadata (in-progress). See Metadata.
• Added info about manually installing the Adobe VSC extension.
• Added additional values for product metadata.

December 2020

• Added information about search metadata in Improving search results.
• Updated metadata (ongoing changes related to landing pages, search filters, and SEO improvements). See Metadata.
• Updated Getting started.

November 2020

• The activate-exl job now pushes content live immediately. The 2-hour pickup schedule applies only to auto-activated repos. See Publish content.

October 2020

• Validating EXL content
• Preview and publish
• Redirects
• Hiding articles
• Acrolinx
• VSC plugins

Business.Adobe.com resources