Decap CMS Editor Guide

This guide explains how to make common content updates in Decap CMS and how to upload/link files (like PDFs).

Before you start

• CMS login: https://www.restorethegulf.gov/admin/
• You must have GitHub access approved for this site.
• This CMS uses a review workflow (drafts do not go live until published).

How publishing works (Draft → Review → Publish)

This site uses Editorial Workflow.

• Save: saves your work as a draft.
• Workflow tab: shows draft/review status.
• Publish: makes the change live.

Tip: If you are not ready for the public site to update, use Save and do not publish yet.

Quick guide: what each collection is for

You can create new entries in these collections

• About Us
• Announcements
• Media Gallery
• Our Work - Environmental Compliance
• Our Work - FPL
• Our Work - Spill Impact Component
• Our Work - What We Do
• Reports

You edit existing pages only (no “new” entry)

• About Us - Council Members
• Contact
• Our Work (Restoration Planning page)
• Policies

Common fields you will see

Many page collections share these fields:

• Title: page title
• Lead: short intro text under heading (optional)
• Eleventy Navigation (optional):
  • Key: unique navigation ID
  • Parent: parent section key
  • Title: alternate menu label
  • Order: smaller number = earlier in menu
• Featured image (optional):
  • Caption
  • Image file
  • Alt text
• Body: main page content (Markdown editor)

Collection: Announcements

Use for news updates and notices.

1. Open Announcements.
2. Click New Announcements.
3. Fill fields:
   • Title
   • Created (auto-filled date; change only if needed)
   • External URL (optional; use when announcement should link out)
   • Body
4. Save draft or publish.

Collection: Media Gallery

Use for videos shown in the media section.

1. Open Media Gallery.
2. Click New Media Gallery.
3. Fill fields:
   • Title
   • Created
   • Vimeo ID (numeric ID from Vimeo URL)
   • Thumbnail (required)
   • Description (optional)
   • Thumbnail Alt Text (optional)
   • Video Caption (optional)
   • Aspect Ratio (default 16/9)
   • Autoplay / Muted / Loop / Plays Inline (optional toggles)
   • Body (optional)
4. Save draft or publish.

Collection: About Us - Council Members

Use to update members/delegates on the Council Members page.

1. Open About Us - Council Members.
2. Open Council Members.
3. Edit Members list:
   • Name, Agency, Title
   • Photo (optional)
   • Delegates list (Type, Name, Agency, Title)
4. Save draft or publish.

Uploading files (PDFs, DOCX, etc.)

Use this process for documents you want to link on pages/posts.

1. Log into Pages: https://pages.cloud.gov
2. Go to Public file storage.
3. Upload the file into the documents folder.
4. Click Copy link after upload.
   • Example result: https://www.restorethegulf.gov/~assets/documents/mbnep_usa_wq_amendment_request_public_comment_1.pdf
5. Go to CMS: https://www.restorethegulf.gov/admin/
6. Edit the page/post where you want the file link.
7. Add the link in the editor (either Markdown or link button).

Example Markdown link:

[Public comments](https://www.restorethegulf.gov/~assets/documents/mbnep_usa_wq_amendment_request_public_comment_1.pdf)

8. Save draft, review, then publish.

Tips to avoid mistakes

• Keep titles short and clear.
• For links, test by opening them in a new tab before publishing.
• Use descriptive link text (not “click here”).
• If navigation order looks wrong, update Eleventy Navigation → Order.
• If something looks off after publishing, reopen the entry, fix, and republish.