DocumentationExperience League Authoring Guide

Create and configure repositories

Last update: August 18, 2026

Create additional repositories and configure for pushing content to dev, stage, and production.

Overview overview

Depending on product release schedules and workflows of various authoring teams across Adobe, you might need to create additional repositories to host various types of documentation that you don’t want to include in the public documentation yet, such as Beta documentation that should only be accessible to a select number of customers.

This article explains how to create a new repository and hook it up to stage and production on experienceleague.adobe.com.

For background information, see User guide setup.

Step 1. File a JIRA ticket (Author) jira-ticket

  1. Log a JIRA ticket (project = UGP; component = Authoring) with a title such as “Add repo to EXL pipeline,” and assign it to Bob Bringhurst.
  2. Indicate the repo name and which landing page it should be added to.
  3. If you’re moving content from a different repo, let Bob know. He’ll help you set up redirects.
  4. Let Bob know if and when you’re ready to publish content or just stage it.

Step 2. (Admin) Create a New Repository create-new-repo

Here’s how to create a new repository:

  1. Go to Adobe-Enterprise-Docs on GitHub and log in with your LDAP credentials.

  2. Click New.

  3. Enter the name of your new repository in the Repository name field.

    Use the <repo-name>.en format, such as campaign-classic.en. Use lower-case letters and hyphens. For Technical Marketing repos with videos, add -learn. Use the .en suffix to allow for localization.

    For service ID, use 566805.

    If you’re not sure what the name of your repo should be, log a JIRA bug (project: UGP) and assign it to Bob Bringhurst. Bob will consult with the editorial stakeholders.

  4. Click Create repository.

    create-new-repo

  5. Change repo settings as needed. (Bob or Admin)

    • Add the lead writer to the repo as Admin.
    • Add .github folder for validation, described later.
    • Create branch protection rules for the main branch. See Git Setup.

Now you can clone your repository locally and start working in it. See Git Setup for details on how to clone your repository locally.

Step 3. (Admin) Add Content

  1. Copy files from a different repo. We like to use the template-new-repo.en repo as a template for copying files.
TIP
On a Mac, press Command+Shift+. to unhide system files. Copy .gitignore and .github to your new repo. Then press Command+Shift+. again to hide system files.

  1. Edit the metadata.md and TOC.md files for the new repo. Include the following:

    • product_v2
    • type (for search filtering)
    • git-repo (for “Edit this page” and “Log an issue”)
    • index (turn search on or off)
    • user-guide-title (displayed on article page)
    • user-guide-description (can be used in landing page description)
    • breadcrumb-title (optional to add shorter guide title in breadcrumb)
    • landing-page-name: <landing-page-filename> (no .md)
    • landing-page-breadcrumb-title: <breadcrumb-title>

    See Metadata and User Guide Setup for details.

  2. Add UICONTROL and DNL tags for localization.

    See Localization Best Practices.

Step 4. (Author) Validate and activate content

  1. Make sure your content is ready to publish. See New Project Publication Checklist.
  2. Make sure your content passes validation.
  3. Commit to main and stage content.
  4. If you’ve moved content from a different repo, submit redirects.

(Admin) Prepare repo for publishing

  • [ ] Make sure repo is configured properly.

    • [ ] All processing files in root folder.
    • [ ] Valid structure for guides. TOC and home page.
    • [ ] Metadata in metadata.md and TOC.md files: git-repo, user-guide-description, breadcrumb-name, solution, type, feature, feature-set, and so on.
    • [ ] Loc tags are added.

  • [ ] Add Loc repos to exl-config/Airtable, if necessary.

  • [ ] Create and configure Github mirror.

  • [ ] Add lead writer to github.com > repo with Admin access.

  • [ ] Add to stage and dev initially, and then add to production when ready.

  • [ ] Change hide: true to index: true after soft launch.

  • [ ] Add link to landing pages, if appropriate.

  • [ ] Connect to Red Pen.

Connect repo to EXL connect-repo-admin

Update the v2 path for stage and dev

  1. In public github (Safari), go to https://github.com/adobe-experience-league/exlm-converter (Public GitHub).

  2. Go to Settings > Environments > stage > V2_PATHS at bottom. Add the path of the new repo.

    Example: /:lang/docs/contributor/:restOfPath*

  3. Be a good soul and add it to dev as well.

Deploy the app to stage and dev

  1. In public github (Safari), go to https://github.com/adobe-experience-league/exlm-converter (Public GitHub).

  2. Click the Actions tab.
    Click Deploy Converter Action.

  3. Choose Run Workflow > and then choose stage.

  4. Deploy dev as well.

  5. Force publish the repo to dev and stage (no longer necessary).

    > node repo-publish.js

Connect to production

  1. Add the repo to the EXL Admin app.

    1. Go to https://github.com/organizations/Adobe-Enterprise-Docs/settings/installations
    2. Click Configure for the EXL Admin app.
    3. Choose the new repo from the Select repositories drop-down list. Add all languages.
    4. Click Save.

  2. Update the v2 path for prod

    1. In public github (Safari), go to https://github.com/adobe-experience-league/exlm-converter (Public GitHub)
    2. Go to Settings > Environments > prod > V2_PATHS at bottom. Add the path of the new repo.

  3. Deploy the app to production

    1. In public github (Safari), go to https://github.com/adobe-experience-league/exlm-converter (Public GitHub).
    2. Click the Actions tab.
    3. Click Deploy Converter Action.
    4. Choose Run Workflow > and then choose main (prod).

  4. Run the bulk publish script on prod:

    node repo-publish.js

(Admin) Configure for Red Pen

  1. Go to https://github.com/organizations/Adobe-Enterprise-Docs/settings/installations
  2. Click Configure for the RedPen Reviewer app.
  3. Choose the new repo (.en only) from the Select repositories drop-down list.
  4. Click Save.

(Admin) Create and configure public mirror

  1. Make sure that git-repo: <repo-name> is specified in the repo’s metadata.md file.

  2. Go to https://github.com/Adobe-Enterprise-Docs/workflows/actions/workflows/create-public-mirror-repos.yml, choose Run Workflow, and specify the repo name.

    This creates all 10 public mirror repos if they don’t already exist.

  3. Add the mirror.yml file to the .github > workflows folder.

    The .github folder is a hidden system file, so press Cmd+Shift+. on a Mac to toggle hide/unhide system files.

recommendation-more-help
authoring-guide-help-main-guide