|
1 | 1 | # ACE SDSSGryphon |
2 | 2 | The ACE SDSSGryphon stack serves the Doerr School of Sustainability. This stack is based on the [SU-SWS/ace-gryphon](https://github.com/SU-SWS/ace-gryphon) stack. |
3 | 3 |
|
4 | | -The primary theme for SDSS is the `sdss_subtheme` located in the `sdss_profile`. |
5 | 4 |
|
6 | 5 | # Docs |
7 | 6 | - [Development Requirements](docs/development-requirements.md) |
8 | 7 | - [New Site Provision](docs/new-site-provision.md) |
9 | 8 | - [Retire Site](docs/retire-site.md) |
10 | 9 |
|
11 | 10 |
|
12 | | -# ADR's |
13 | | -This site uses Architecture Decision Records to record important technical decisions and the context surrounding them. ADR's can be found in [docs/architecture/decisions](docs/architecture/decisions/). For more information see [0. Record architecture decisions](docs/architecture/decisions/0000-record-architecture-decisions.md). |
| 11 | +# SDSS Theme |
| 12 | +The primary theme for SDSS is the `sdss_subtheme` located in the `sdss_profile`. Theme assets can be compiled via composer in the root directory. |
| 13 | + |
| 14 | +1. Ensure you have the required Node version (see `.nvmrc` in the project root). |
| 15 | +2. Run `nvm use` in your terminal (one time only per session). |
| 16 | +3. Run `composer build-theme` to compile theme assets. |
14 | 17 |
|
15 | 18 |
|
16 | | -# GitPod Setup |
17 | | -1. Add your ssh key to [GitPod](https://gitpod.io/variables) |
18 | | - 1. It is recommended to have a password-less ssh key for simplicity. |
19 | | - 1. `ssh-keygen -b 4096`, press enter when asked for the password |
20 | | - 2. Add this ssh public key to the necessary services: Acquia, Github, etc. |
21 | | - 2. Get the base64 string of your ssh key files |
22 | | - 1. `cat id_rsa | base64` for the private key |
23 | | - 2. `cat id_rsa.pub | base64` for the public key. |
24 | | - - NOTE: Use `-w0` with base64 to remote any white space/line breaks. |
25 | | - 1. Get the base64 string of your gitconfig |
26 | | - 1. `cat ~/.gitconfig | base64` |
27 | | - 3. In GitPod, add a variable named `SSH_PRIVATE_KEY` with the base64 encoded private key |
28 | | - 4. In GitPod, add a variable named `SSH_PUBLIC_KEY` with the base64 encoded public key |
29 | | - 5. In Gitpod, add a variable named `GITCONFIG` with your base64 encoded git config |
30 | | - - NOTE: Verify that the `fetch = +refs/heads/*:refs/remotes/origin/*`line is not present in the git config as it prevents the installation of development packages. |
31 | | -2. Recommended, but not required: |
32 | | - 1. Install the GitPod browser plugin |
33 | | - 2. Configure your browser settings for an easier experience: https://www.gitpod.io/docs/configure/browser-settings |
34 | | -3. Open a gitpod workspace with [these instructions](https://www.gitpod.io/docs/getting-started#start-your-first-workspace) |
35 | | - |
36 | | - |
37 | | -# Config Management |
38 | | -Each site has the ability to determine its own configuration management strategy. |
39 | | -The default site in this repo will be using a configuration management that uses |
40 | | -the configuration from the `sdss_profile`. By default this is the behavior |
41 | | -of all other sites unless defined within their own settings.php. |
42 | | - |
43 | | -There are three options a site can choose from: |
44 | | -1. Do nothing and the configuration sync directory will use what is in `sdss_profile`. |
45 | | -2. Modify the configuration sync directory to a desired directory such as another profile. |
46 | | -3. Modify the configuration sync directory to point to an empty directory. This |
47 | | -will bypass any configuration management strategy and the site's configuration will be updated via update hooks. |
| 19 | +# ADR's |
| 20 | +This site uses Architecture Decision Records to record important technical decisions and the context surrounding them. ADR's can be found in [docs/architecture/decisions](docs/architecture/decisions/). For more information see [0. Record architecture decisions](docs/architecture/decisions/0000-record-architecture-decisions.md). |
48 | 21 |
|
49 | 22 |
|
50 | 23 | # Setup Local Environment - Native LAMP Stack |
@@ -75,12 +48,6 @@ SAML and other certificate files will be download for local use. |
75 | 48 | $ blt sws:keys |
76 | 49 | ``` |
77 | 50 |
|
78 | | -Optional: |
79 | | -If you wish to not provide statistics and user information back to Acquia run |
80 | | - ``` |
81 | | - $ blt blt:telemetry:disable --no-interaction |
82 | | - ``` |
83 | | - |
84 | 51 | # Setup Local Environment - Lando |
85 | 52 | You can set up this stack as a complete development environment using nothing more than Docker and Lando installed in your linux-like environment. |
86 | 53 |
|
@@ -113,7 +80,3 @@ BLT uses a number of configuration (`.yml` or `.json`) files to define and custo |
113 | 80 | * `blt/local.blt.yml` (local only specific blt configuration) |
114 | 81 | * `drush/sites` (contains Drush aliases for this project) |
115 | 82 | * `composer.json` (includes required components, including Drupal Modules, for this project) |
116 | | - |
117 | | -# Resources |
118 | | - |
119 | | -* GitHub - https://github.com/SU-SWS/ace-gryphon |
0 commit comments