Work with GitHub pull requests and issues

Users—both internal and external—can use the Edit this page and Log an issue options in experienceleague.adobe.com articles.

For details about how you or other users can log issues or edit pages on GitHub, see the Adobe Contributor Guide.

Summary of what Adobe writers should do

Enterprise Git (github.com/Adobe-Enterprise-Docs) and Public Git (github.com/adobedocs) are different environments that require different log-in accounts and have different configuration settings.

To watch a video, see Working with public mirrors.

Sign up for GitHub notifications github-notifications

Keep in mind that notification settings for github.com/Adobe-Enterprise-Docs and github.com/adobedocs are different and require different log-in accounts and separate configurations.

You can enable notifications so that you get an email message whenever anyone logs an issue or submits a pull request for the public docs on github.com.

By default, you don’t get notifications whenever you make changes to the repo, just when other people do.

If you want different access rights, such as the ability to close issues or pull requests on github.com, contact the SSE team.

Monitor incoming contributions

In order to keep track of all incoming contributions:

Authors should watch their repo, both corp (git.corp.adobe.com) and public (github.com). See Sign up for GitHub notifications.

The workflow for managaging pull requests differs for corp and public, so make sure that you have a method for identifying public GitHub.com requests. For example, in email notifications, Corp notifications include a colored icon, whereas public GitHub.com requests include a black-and-white icon.

React to the contributions as they come in:

If you work on a project with multiple team members, consider setting up a triage system. For an example, see the AEM team’s Managing Contributions wiki workflow.

GitHub > Jira workflow github-jira-workflow

The AEM team created an automation process to auto-generate JIRA tickets from any issue logged in the GitHub.com repo. This workflow allows support operators to use the GitHub Log an issue feature as their point of entry in reporting documentation issues.

See DocBug GJSS Automation

Contact the SSE team if you’re interested in a similar implementation.

Copy GitHub pull request to Git Corp (Admin) copy-github-pr

This process is for the SSE team or for anyone else who wants to copy a pull request from GitHub to Git Corp. If you want to copy pull requests yourself, let the SSE team know so that we don’t duplicate efforts.

To watch a video, see Copying pull requests from public mirror to corp.

Example Details

Suppose you have the following pull request.

In this example, the mtalbot29 user created the pull request in a fork (also mtalbot29) in the patch-2 branch in the target.en repo.

cd Documents/GitHub/target.en
git checkout -b mtalbot29-patch-2 main
git pull --no-rebase https://github.com/mtalbot29/target.en.git patch-2

The first line goes to the target.en directory.

The second line creates a branch in the target.en directory called mtalbot29-patch-2 based on the main branch.

The third line copies the edits from the public repo to your local directory and commits the files to the mtalbot-patch-2 branch.

Follow the steps above to complete pull request and merge into main.

Create a public git mirror (SSE team) create-public-git

Before you go public with a repository, you need to create a public git mirror repository that contributors can work with. This is the repository that is linked to for Edit this Page or Log an Issue in the right rail of every article.

In addition, after creating the public mirror, in the metadata.md file of the repo that you’re launching, you need to make sure the git-repo setting address goes to your mirror repo.