This document provides a general overview of the content repository structure.
Although we refer to it as the VA.gov Interim CMS, the content files here are part of a GitHub repository, or "repo" for short. It's really just a shared directory that retains a complete history of changes, including all saves, edits, deletes, and more.
As of this writing, the directory structure consist of the following (in order of importance):
The content pages for VA.gov. Each file here is visible on the website as an HTML webpage.
The directory structure determines the published-website hierarchy (called the information architecture) and the URL. For example, pages/health-care/sample-page.md
will be published to www.va.gov/health-care/sample-page/
.
As indicated by the .md
file extension, these pages are written in the Markdown format.
Static assets that are linked to or referenced by content pages. This includes PDFs, images, and more.
Specific chunks of content, such as for a certain website component. An example of this is the homepage warning banner.
Documentation, such as for the doc you're reading now :slighty_smiling_face:.
Configurations for the repo specifically for GitHub.com.
Files at the root of the repo are configurations for Heroku review instances. These can be ignored by non-developers.