Technical
Documentation
Add Photos

Add Photos

This documentation assumes the use of GitHub.conm for editing documentation and adding photos. Use Add, Edit, Publish Documentation for a detailed explanation on how to use GitHub.com

Adding photos to a page requires two steps: uploading the photo to the documentation site and adding the photo to the page.

Upload the photo

All photos are stored in the public/photos folder. To upload a photo, click the public/photos folder in the file tree and then click the Upload files button on GitHub.

Add the photo to the page

To add the photo to the page, use the syntax below. All paths to a photo start with /photos/:

![Alt text](/photos/route/to/photo.png)

Best Practices

  • Upload photos to a folder in /public/photos/ that is specific to section of the site where it will be used. For example, all Drupal photos should be stored in /public/photos/drupal/ and all photos for Drupal documentation pertaining to the installation of the site to /public/photos/drupal/installation/.
  • Chose a file name that is descriptive of the photo. For example, drupal-installation-1.png is a better file name than screenshot-1.png.
  • Use alt text that is descriptive of the photo. For example, Screenshot of the Drupal installation screen is a better alt text than Screenshot 1.
Add, Edit, Publish PagesInstallation