How to Create a GitHub Issue#

This how-to will help you create a GitHub issue related to the Open edX documentation.

Prerequisites#

Creating an Issue from GitHub#

  1. Log in to your GitHub account and go under the repository docs.openedx.org.

  2. On the Navigation Bar, click on Issues.

    This image shows the GitHub navigation bar and the Issues option.
  3. On the left side of the page, click on New Issue.

    This image shows the New Issue Button.
  4. You will see a menu from which you can create an issue from scratch or use one of the templates already defined by the community. Regarding documentation, the recommendation is to use the template Report Issue With Existing File (for docs writers).

    This image shows the Issues Templates menu.
  5. Fill in all mandatory fields: “Issue Title”, “Filename” and “What is broken about this file?”. A detailed description of the issue is highly recommended to enhance understanding of the requirements. Here, you can also assign the issue to a particular user, but it is preferable to wait for a volunteer.

  6. Click the button Create to upload the issue.

    This image shows the Documentation Issue Template Form.

Creating an Issue from a Document#

This guide outlines the process for creating an issue to report a problem, suggest an improvement, or request updates in the Open edX documentation repository while you are consulting a particular document.

  1. When viewing a document on docs.openedx.org, scroll to the top of the page.

  2. Click the GitHub icon at the right corner of the page.

  3. A menu will scroll down, and you will see three options. Click on Open an Issue.

    This image shows the Open an Issue Option in the Options menu of the Open edX documentation.
  4. Fill in all mandatory fields: “Issue Title”, “Filename” and “What is broken about this file?”. A detailed description of the issue is highly recommended to enhance understanding of the requirements. Here, you can also assign the issue to a particular user, but it is preferable to wait for a volunteer.

  5. Click the button Create to upload the issue.

    This image shows the Documentation Issue Template Form.