Editing Workflow for the Occasional Adobe Contributor

If you work at Adobe and want to contribute to Adobe documentation, you have several options to choose from.

Overview of options

  • Log an issue - Simply log an issue with a request for the writer to make changes.
  • Make simple edits in the browser - Go to the page in Git that you want to edit, make your changes, and submit a request.
  • Use the full editing workflow - Use all or part of the authoring workflow. This workflow is suitable for a contributor who needs to make a major change or will be a frequent contributor to a repository. This workflow requires some training to learn about Git workflows, Markdown syntax, and the Jenkins validation process. See Git Workflow for Adobe Lead Writers.

Setup

If you are an Adobe employee, we recommend that you go to https://git.corp.adobe.com/adobedocs and sign in using your Adobe enterprise (LDAP) account.

You can then contribute to our internal AdobeDocs repositories.

Although it’s preferable for you to log issues or edit content on the internal AdobeDocs site on git.corp.adobe.com, you can also make contributions on the public facing mirror on github.com, like any user.

TIP

Unfortunately, we don’t yet sniff out Adobe employees and automatically redirect them to the Adobe Corp site. However, when you edit a page in experienceleague.adobe.com, you can manually change the URL from https://github.com to https://git.corp.adobe.com. This allows you to submit pull requests in the primary Corp repo rather than the public mirror.

Sign up for GitHub.com account

To contribute changes or additions to Adobe (or other organizations) documentation on the public GitHub.com site, use a GitHub account (not your Adobe enterprise account).

  1. If you don’t already have a GitHub account, go to https://github.com/join.
  2. Follow the prompts to create your account.

Workflow

Let’s cover the two workflows for casual contributors: logging an issue and making direct edits in the browser.

Logging an issue

When you log an issue, you essentially ask the writer to make changes for you.

  1. Open an article on either stage or production.
  2. Click the Log an issue option in the right rail.

log issue image

  1. Write your request and click Submit new issue.

submit issue image

The lead writer will be notified of your issue submission.

Making direct edits

  1. Do one of the following:

    • In your browser, open your repo in git.corp.adobe.com/adobedocs. Locate the file you want to edit.
    • Open an article on experienceleague.adobe.com in either stage or production. Click the Edit this page option in the right rail.

    log issue image

  2. Click the pencil icon, and make your edits.

    edit icon

    See the Markdown cheat sheet or Markdown syntax guide for instructions on using Markdown.

  3. When you finish editing the page, select the option to create a branch, and then click Propose file change. You’ll then submit a pull request

    direct browser edit

Before your pull request can be merged into its destination branch, it is required to pass through one or more PR validation processes. After your pull request is submitted, you can expect the content to be reviewed and, if and when appropriate, merged into the main repository.

When the pull request is issue-free and signed off, your changes are merged back into the parent branch and the pull request is closed.

Making major edits

If you want to dive in and make major editing contributions, see Git Workflow for Adobe Lead Writers.

On this page