Skip to main content Link Search Menu Expand Document (external link)

This page describes straightforwardly on how to edit and contribute to this documentation

  1. How to edit a page
    1. Click on “edit this page”
    2. Edit the page
    3. Create a pull request
  2. How to edit/contribute to an existing pull request
    1. Click on “File changed”
    2. Scroll to the file you want to edit and click on the edit button
    3. Make your change and submit a commit
  3. How to add images
    1. Fork the project
    2. Upload an image, commit and open a pull request

How to edit a page

Click on “edit this page”

At the bottom of each page, you will find a link that will take you to the corresponding markdown file

image

Edit the page

image

Create a pull request

image

How to edit/contribute to an existing pull request

Click on “File changed”

image

Scroll to the file you want to edit and click on the edit button

image

Make your change and submit a commit

image

How to add images

Fork the project

You can’t upload a file directly to the repository. Instead, you need to fork the project: image If you already forked the project, you can click the “Sync fork” button in your repository to make sure it is up to date with the current state of the documentation.

Upload an image, commit and open a pull request

Navigate to assets/images/ontoportal (or assets/images/ontoportal/figures/PortalName for user documentation figures) and click “Add file”: image

Drag and drop or select your file and then commit into a new branch: image

Open a pull request onto the original repository. Click “compare across forks” to access it: image

Select base repository: ontoportal/documentation and base: master You can now create the pull request: image Note: you can also add and modify documentation pages in the new branch before creating a pull request.