Skip to content

Uploading Files

Toni Bonitto edited this page Sep 21, 2021 · 2 revisions

How to upload a PDF or other files

File naming

Follow these criteria to name your files:

  • All letters should be lower case (use selfie-sara-cope not selfie-Sara-Cope and not selfieSaraCope)
  • Do not include spaces between words (use my-image-file not my image file)
  • Do not use any special characters like & or # in the filename (regular numbers are fine)

Stage 1: Add the file(s)

  1. Create a new branch
    1a. FOR PDFS: Go to https://github.com/GSA/digitalgov.gov/tree/main/static/pdf (open in a new tab)
    1b. FOR OTHER FILES: Go to https://github.com/GSA/digitalgov.gov/tree/main/static/files (open in a new tab)
  2. Select Add File -> Upload File and upload your file
  3. Commit the change in your own branch that you created
  4. Create a pull request (PR) to add the file(s)
  5. Request that the PR be reviewed and merged

After that pull request is merged, your PDF will be available at: https://digital.gov/pdf/FILENAME.pdf.
Other files will be available at: https://digital.gov/files/FILENAME.pptx (or whatever the file extension is; .doc, .xlsx, etc.)

Stage 2: Linking to the file(s)

  1. Find the page you want to add your file to
  2. Add a markdown formatted link to the file that includes the file size, type and number of pages after the link (see example below)
  3. Create a pull-request that will add the file link to the page

Examples

markdown:

[link text](https://digital.gov/pdf/FILENAME.pdf) (PDF, 372 KB, 8 pages)

link:
link text (PDF, 372 KB, 8 pages)

Clone this wiki locally