Andre/appeals 57834 sidebar toggle

.github/ISSUE_TEMPLATE/tech-spec.md

@@ -8,16 +8,16 @@ assignees: ''
 ---
 
 # Tech Spec Title
-**Drafter**: <!-- Your name -->  
-**Discussion Meeting**: <!-- Date to discussion the spec as a team; send calendar invite! -->  
+**Drafter**: <!-- Your name -->
+**Discussion Meeting**: <!-- Date to discussion the spec as a team; send calendar invite! -->
 
 <!-- Tech specs are a lightweight format for documenting technical research and decision making. The headings below are guidelines, not rules, so modify your copy as you see fit. Especially large tech specs may require more headings and subheadings for example. Be rigorous in your research and planning, but balance that with forward progress - if something is uncertain, document that appropriately and move on if you can. Getting feedback early from team mates during tech spec writing can be helpful too.
 Tech specs are considered 'done' when key stakeholders have reviewed and approved the approach. -->
 
 ## Context
-<!-- Why are you creating this tech spec? 
+<!-- Why are you creating this tech spec?
 
-What information helps readers understand the rest of this tech spec? 
+What information helps readers understand the rest of this tech spec?
 
 Who are the stakeholders? -->
 
@@ -31,11 +31,11 @@ Who are the stakeholders? -->
 <!-- Concerns about potential solutions. Explicitly state if they should be addressed in the chosen solution. -->
 
 ## Open Questions
-<!-- Sometimes we're missing information needed to fully spec work. 
+<!-- Sometimes we're missing information needed to fully spec work.
 What is missing? Who can answer these questions, and how might it affect the recommendation? -->
 
 ## Implementation Options
-<!-- 
+<!--
 Consider multiple implementation paths.
 What are their recommended action items?
 These may change as feedback is given, but after the tech spec is approved these should be written as fully defined/pointed github issues.
@@ -66,4 +66,4 @@ How will we safely ship this work? Are there migrations, external dependencies t
  - [ ] Tech spec drafter: Turn tech spec into next-step actionable tickets.
     - [ ] Write tickets as is necessary
     - [ ] Other developers provide more formal feedback as is necessary.
-- [ ] Once the tech spec is finalized, open a PR to add it to the docs/tech-specs directory following [these instructions](https://github.com/department-of-veterans-affairs/caseflow/tree/master/docs/tech-specs/README.md)
+- [ ] Once the tech spec is finalized, open a PR to add it to the docs/tech-specs directory following [these instructions](https://github.com/department-of-veterans-affairs/caseflow/tree/main/docs/tech-specs/README.md)

.github/workflows/main.yml

@@ -1,7 +1,7 @@
-name: PRs to master
-on: 
+name: PRs to main
+on:
   pull_request:
-    branches: [master]
+    branches: [main]
     types: [closed]
 jobs:
   merge-master-back-to-dev:
@@ -14,10 +14,10 @@ jobs:
       run: |
           git config --local user.email "[email protected]"
           git config --local user.name "Jeremy Shields"
-    - name: Merge master back to dev
+    - name: Merge main back to dev
       run: |
           git fetch --unshallow
           git checkout development
           git pull
-          git merge -Xtheirs --no-ff master -m "Auto-merge master back to dev"
+          git merge -Xtheirs --no-ff main -m "Auto-merge main back to dev"
           git push

.github/workflows/make-docs.yml

@@ -1,10 +1,10 @@
 name: Make-docs-to-webpage
 
-# Trigger whenever changes are made to the master branch
+# Trigger whenever changes are made to the main branch
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   make_docs:

Dangerfile

@@ -25,7 +25,7 @@ if git.modified_files.grep(/app\/services\//).any?
   )
 end
 
-# Don't let testing shortcuts get into master by accident
+# Don't let testing shortcuts get into main by accident
 if `git diff #{github.base_commit} spec/ | grep -E '(:focus => true)|(focus: true)'`.length > 1
   fail("focus: true is left in test")
 end

Gemfile

@@ -65,7 +65,7 @@ gem "pdfjs_viewer-rails", git: "https://github.com/senny/pdfjs_viewer-rails.git"
 # Used to build out PDF files on the backend
 # https://github.com/pdfkit/pdfkit
 gem "pdfkit"
-gem "pg", platforms: :ruby
+gem "pg", "~> 1.5.7", platforms: :ruby
 # Application server: Puma
 # Puma was chosen because it handles load of 40+ concurrent users better than Unicorn and Passenger
 # Discussion: https://github.com/18F/college-choice/issues/597#issuecomment-139034834
@@ -104,7 +104,7 @@ gem "ziptz"
 group :production, :staging, :ssh_forwarding, :development, :test do
   # Oracle DB
   gem "activerecord-oracle_enhanced-adapter", "~> 6.1.0"
-  gem "ruby-oci8", "~> 2.2"
+  gem "ruby-oci8", "~> 2.2.14"
 end
 
 group :test, :development, :demo, :make_docs do

Gemfile.lock

@@ -1839,7 +1839,7 @@ GEM
       cliver (~> 0.3.2)
       safe_shell (>= 1.0.3, < 2.0)
     pdfkit (0.8.7.2)
-    pg (1.1.4)
+    pg (1.5.7)
     pluck_to_hash (1.0.2)
       activerecord (>= 4.0.2)
       activesupport (>= 4.0.2)
@@ -1990,7 +1990,7 @@ GEM
     ruby-debug-ide (0.7.3)
       rake (>= 0.8.1)
     ruby-graphviz (1.2.4)
-    ruby-oci8 (2.2.7)
+    ruby-oci8 (2.2.14)
     ruby-plsql (0.8.0)
     ruby-prof (1.4.1)
     ruby-progressbar (1.13.0)
@@ -2201,7 +2201,7 @@ DEPENDENCIES
   pdf-forms
   pdfjs_viewer-rails!
   pdfkit
-  pg
+  pg (~> 1.5.7)
   pluck_to_hash
   pry (~> 0.13.0)
   pry-byebug (~> 3.9)
@@ -2229,7 +2229,7 @@ DEPENDENCIES
   rubocop-performance
   rubocop-rails
   ruby-debug-ide
-  ruby-oci8 (~> 2.2)
+  ruby-oci8 (~> 2.2.14)
   ruby-prof (~> 1.4)
   ruby_claim_evidence_api!
   sass-rails (~> 5.0)

Jenkinsfile

@@ -13,9 +13,9 @@ def APP_VERSION = env.APP_VERSION ?: 'HEAD';
 
 def DEPLOY_MESSAGE = null
 
-// Allows appeals-deployment branch (defaults to master) to be overridden for
+// Allows appeals-deployment branch (defaults to main) to be overridden for
 // testing purposes
-def DEPLOY_BRANCH = (env.DEPLOY_BRANCH != null) ? env.DEPLOY_BRANCH : 'master'
+def DEPLOY_BRANCH = (env.DEPLOY_BRANCH != null) ? env.DEPLOY_BRANCH : 'main'
 
 /************************ Common Pipeline boilerplate ************************/
 
@@ -43,7 +43,7 @@ node('deploy') {
         checkout scm
         DEPLOY_MESSAGE = sh (
           // this script will:
-          // get the latest `deployed` release created by: https://github.com/department-of-veterans-affairs/appeals-deployment/blob/master/ansible/utility-roles/deployed-version/files/tag_deployed_commit.py
+          // get the latest `deployed` release created by: https://github.com/department-of-veterans-affairs/appeals-deployment/blob/main/ansible/utility-roles/deployed-version/files/tag_deployed_commit.py
           // compare current HEAD commit to the last deployed release
           // save the message to be announced in Slack by the pipeline
           script: "git log \$(git ls-remote --tags https://${env.GIT_CREDENTIAL}@github.com/department-of-veterans-affairs/caseflow.git \
@@ -79,4 +79,4 @@ if (env.COMMON_PIPELINE_TASK == 'bake') {
   commonPipeline.build(APP_NAME, APP_VERSION, DEPLOY_MESSAGE);
 } else if (env.COMMON_PIPELINE_TASK == 'deploy'){
   commonPipeline.deploy(APP_NAME, APP_VERSION, DEPLOY_MESSAGE);
-}
+}

MAC_M1.md

@@ -187,10 +187,10 @@ Running Caseflow
 	  2. that you are using arm64 brew by doing `which brew` and ensuring the output is `/opt/homebrew/bin/brew`
 3. Open caseflow in VSCode (optional), or navigate to the caseflow directory in your terminal and:
 	  1. `brew install yarn`
-4. Ensure you are on master branch and up to date by running
-    1. ```git checkout master```
+4. Ensure you are on main branch and up to date by running
+    1. ```git checkout main```
     2. ```git fetch```
-    3. ```git pull origin master```
+    3. ```git pull origin main```
 5. Start Vacols UTM VM (if not already running)
 6. run `make up-m1` to create the docker containers and volumes
 7. run `make reset` to (re)create and seed the database; this takes a while (~45 minutes)

Makefile.example

@@ -35,7 +35,7 @@
 #   # pulled latest from github? try:
 #   % make install migrate
 #
-#   # get fully up to date with master on origin and all deps & db?
+#   # get fully up to date with main on origin and all deps & db?
 #   % make update
 #
 # Hopefully the targets are easy enough to remember to make this useful to others.
@@ -240,7 +240,7 @@ migrate: external-db-remove etl-migrate etl-test-prepare db-migrate ## Migrate a
 
 rollback: etl-rollback db-rollback	## Rollback all Rails databases
 
-fresh:  ## https://github.com/imsky/git-fresh - updates local master to match origin, stashes changes, prunes remote branches
+fresh:  ## https://github.com/imsky/git-fresh - updates local main to match origin, stashes changes, prunes remote branches
 	git fresh
 
 reset: reset-dbs seed-dbs enable-feature-flags ## Resets databases and enable feature flags
@@ -261,6 +261,9 @@ seed-dbs:	## Seed all databases
 	bundle exec rake spec:setup_vacols
 	bundle exec rake db:seed
 
+setup-metabase:
+	./metabase/metabase_api_script.sh
+
 enable-feature-flags: ## enable all feature flags
 	bundle exec rails runner scripts/enable_features_dev.rb
 
@@ -272,7 +275,7 @@ client-install:  ## Installs javascript dependencies
 
 install: bundle-install client-install  ## Installs all dependencies
 
-update: fresh install migrate  ## Get fully up to date with origin master - pulls origin, installs all deps and runs any db migrations
+update: fresh install migrate  ## Get fully up to date with origin main - pulls origin, installs all deps and runs any db migrations
 
 client-build-test client-test:  ## Builds webpack for tests
 	cd client && yarn run build:test

PULL_REQUEST_TEMPLATE.md

@@ -11,7 +11,7 @@ Please explain the changes you made here.
 <!-- Change JIRA-12345 to reflect the URL of the location of the test plan(s) for this PR -->
 1. Go to [Jira Issue/Test Plan Link](https://jira.devops.va.gov/browse/JIRA-12345) or list them below
 
-- [ ] For feature branches merging into master: Was this deployed to UAT?
+- [ ] For feature branches merging into main: Was this deployed to UAT?
 
 # Frontend
 ## User Facing Changes
@@ -31,7 +31,7 @@ Please explain the changes you made here.
 *Only for Schema Changes*
 
 * [ ] Add typical timestamps (`created_at`, `updated_at`) for new tables
-* [ ] Update column comments; include a "PII" prefix to indicate definite or potential [PII data content](https://github.com/department-of-veterans-affairs/appeals-team/blob/master/caseflow-team/0-how-we-work/pii-handbook.md#what-is-pii)
+* [ ] Update column comments; include a "PII" prefix to indicate definite or potential [PII data content](https://github.com/department-of-veterans-affairs/appeals-team/blob/main/caseflow-team/0-how-we-work/pii-handbook.md#what-is-pii)
 * [ ] Have your migration classes inherit from `Caseflow::Migration`, especially when adding indexes (use `add_safe_index`) (see [Writing DB migrations](https://github.com/department-of-veterans-affairs/caseflow/wiki/Writing-DB-migrations))
 * [ ] Verify that `migrate:rollback` works as desired ([`change` supported functions](https://edgeguides.rubyonrails.org/active_record_migrations.html#using-the-change-method))
 * [ ] Perform query profiling (eyeball Rails log, check bullet and fasterer output)

README.md

@@ -156,7 +156,7 @@ First you'll need to install ansible-vault and credstash.
 pip install ansible-vault
 pip install credstash
 ```
-For more credstash setup, follow [the doc](https://github.com/department-of-veterans-affairs/appeals-deployment/blob/master/docs/credstash.md#using-credstash)
+For more credstash setup, follow [the doc](https://github.com/department-of-veterans-affairs/appeals-deployment/blob/main/docs/credstash.md#using-credstash)
 
 We'll need to obtain the Ansible vault password using credstash:
 
@@ -267,8 +267,8 @@ Rails.cache.write(:degraded_service_banner, :auto)
 
 We have a lot of technical documentation spread over a lot of different repositories. Here is a non-exhaustive mapping of where to find documentation:
 
-- [Local Caseflow Setup](https://github.com/department-of-veterans-affairs/caseflow/tree/master/docs)
+- [Local Caseflow Setup](https://github.com/department-of-veterans-affairs/caseflow/tree/main/docs)
 - [Test data setup in lower environments](https://github.com/department-of-veterans-affairs/appeals-qa/tree/master/docs)
-- [Caseflow specific devops documentation](https://github.com/department-of-veterans-affairs/appeals-deployment/tree/master/docs) This folder also contains our [first responder manual](https://github.com/department-of-veterans-affairs/appeals-deployment/blob/master/docs/first-responder-manual.md), which is super in understanding our production systems.
+- [Caseflow specific devops documentation](https://github.com/department-of-veterans-affairs/appeals-deployment/tree/main/docs) This folder also contains our [first responder manual](https://github.com/department-of-veterans-affairs/appeals-deployment/blob/main/docs/first-responder-manual.md), which is super in understanding our production systems.
 - [Non-Caseflow specific devops documentation](https://github.com/department-of-veterans-affairs/devops/tree/master/docs). This documentation is shared with the vets.gov team, so not all of it is relevant.
-- [Project documentation](https://github.com/department-of-veterans-affairs/appeals-design-research/tree/master/Project%20Folders)
+- [Project documentation](https://github.com/department-of-veterans-affairs/appeals-design-research/tree/main/Project%20Folders)

WINDOWS_11.md

@@ -130,7 +130,7 @@ Run each line is a separate command, run them one at a time
 
 24. Close and restart VS Code
 
-25. branch should be up to date with master (```git checkout master```, ```git pull```)
+25. branch should be up to date with main (```git checkout main```, ```git pull```)
 
 26. ```cd ~/appeals/caseflow in terminal```
 

app/controllers/route_docs_controller.rb

@@ -2,7 +2,7 @@
 
 class RouteDocsController < ApplicationController
   class DocumentedRoute
-    SOURCE_URL_PREFIX = "https://github.com/department-of-veterans-affairs/caseflow/blob/master/app/controllers/"
+    SOURCE_URL_PREFIX = "https://github.com/department-of-veterans-affairs/caseflow/blob/main/app/controllers/"
 
     attr_reader :rails_route