Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VOTE-2817 update release documentation #991

Merged
merged 2 commits into from
Sep 20, 2024
Merged

VOTE-2817 update release documentation #991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
112d87c
VOTE-2817 update release documentation
rayestrada Sep 17, 2024
41b39d3
VOTE-2689 update docs for launched CMS
rayestrada Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
## Environments and git branches
List of development environments and their equivalent git branches.

| **Public (static)** | **CMS** | **Cloud.gov environments** | **Git branch** | **Use case** |
|---------------------|--------------------|----------------------------|----------------|----------------------------------------------------------|
| ssg-dev.vote.gov | cms-dev.vote.gov | vote-drupal-dev | dev | App work that is ready for testing in cloud.gov |
| ssg-test.vote.gov | cms-test.vote.gov | vote-drupal-test | test | Pipeline development work ready for testing in cloud.gov |
| staging.vote.gov | cms-stage.vote.gov | vote-drupal-stage | stage | All work that is ready for release/UAT testing |
| vote.gov | cms.vote.gov | vote-drupal-prod | prod | All work that is approved and released |
| **Static** | **CMS** | **Cloud.gov environments** | **Git branch** | **Use case** |
|-------------------|--------------------|----------------------------|----------------|----------------------------------------------------------|
| ssg-dev.vote.gov | cms-dev.vote.gov | vote-drupal-dev | dev | App work that is ready for testing in cloud.gov |
| ssg-test.vote.gov | cms-test.vote.gov | vote-drupal-test | test | Pipeline development work ready for testing in cloud.gov |
| staging.vote.gov | cms-stage.vote.gov | vote-drupal-stage | stage | All work that is ready for release/UAT testing |
| vote.gov | cms.vote.gov | vote-drupal-prod | prod | All work that is approved and released |

## Table of Contents
- [Git standards](standards.md)
Expand Down
6 changes: 0 additions & 6 deletions docs/backend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,18 +73,12 @@ A CKEditor5 Embedded Content plugin that provides a means for embedding a Touchp
#### USAgov login
Adds the ability to disable the default Drupal login form and replace with a button to log in via SSO.

#### Vote migrate
Migration scripts to run to import translations from GitHub pages.cloud.gov site.

#### Vote utility
Provides custom token for use in pathauto settings. Adds the ability to limit the storage of block content revisions. Stores the source po files for importing string translations in the system.

## Module Patches
Review the details in composer.json file under `extra.patches` additionally look at the `/patches/` directory at the root. These patches need to be re-evaluated when the original module gets updated to determine if the work has been included in the latest release or if the patch needs to be rerolled.

## Migration
Instructions for updating and running migration scripts.

## Database - Mysql
The site utilizes Mysql for its database.

Expand Down
16 changes: 10 additions & 6 deletions docs/frontend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ This site is built using Drupal and Tome with a USWDS theme.
These commands should be run inside web/themes/custom/votegov
| **Command** | **Use case** |
|------------------|-----------------------------------------------------------------------------------|
| `npm run build` | Aggregates, compiles and minifies frontend assets into the dist directory |
| `npm run dev` | Starts browsersync, watches for scss/js/twig file changes and compiles frontend assets into the dist directory |
| `npm run build` | Aggregates, compiles and minifies frontend assets into the dist directory for deployment |
| `npm run dev` | Starts watching for changes to scss/js/twig files and compiles frontend assets into the dist directory |

## Theme file structure
```
Expand All @@ -21,9 +21,11 @@ web/
├── dist
├── fonts
├── img
├── json
├── php-includes
├── js
├── sass
└── src/
├── js
└── sass
└── templates
```

Expand All @@ -33,11 +35,13 @@ web/

**img** - All favicons and logos that compile into dist

**json** - Number translation mapping json for frontend utility replacement

**php-includes** - Preprocess and theme functions organized by use type

**js** - Javascript files that compile into dist
**src/js** - Javascript files that compile into dist

**sass** - SCSS files that compile into dist
**src/sass** - SCSS files that compile into dist

**templates** - Vote.gov theme templates and template overrides. Templates inside the /templates/partial directory are being included or extended by other templates.

Loading