audrey/intranet
1
0
Fork 1
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

link, formatting, and other changes

Browse Source
This commit is contained in:
Audrey Jensen 2023-08-09 19:43:26 +00:00
parent 368b3e609e
commit 6f44b0965e
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -99,7 +99,10 @@ d. Rewrite URL: `/Index.php`
11. (Optional) Prepare the site cache 11. (Optional) Prepare the site cache
a. Open a terminal into the web app folder (i.e. C:/Symfony) a. Open a terminal into the web app folder (i.e. C:/Symfony)
b. Run: `php bin/console cache:warmup` b. Run: `php bin/console cache:warmup`
 
### Configure The App
In the project directory, you should have changed `.env-prod` to `.env` during install.
This file contains our general configurations. By default, it comes preset for your environment, but double check that everything is how you want it.
### Final Deployment Considerations ### Final Deployment Considerations
- Make sure the IIS user (ISUR or whatever the AppPoolIdentity is) has read & write privileges within the /var directory. - Make sure the IIS user (ISUR or whatever the AppPoolIdentity is) has read & write privileges within the /var directory.
- Make sure Symfony is not running in DEBUG mode (APP_DEBUG should not be true in env vars.) - Make sure Symfony is not running in DEBUG mode (APP_DEBUG should not be true in env vars.)
@ -109,18 +112,14 @@ When new code is pushed to the remote master, it can be synchronized using a sim
```bash ```bash
git pull git pull
``` ```
After this is done, run `Update.bat` in the project directory.
So long as best practices with Git are respected, and the remote is available, the production codebase should be updated to reflect the most recent version. So long as best practices with Git are respected, and the remote is available, the production codebase should be updated to reflect the most recent version.
After this is done, open a terminal to the project root (where bin is located) and run these commands, in this order:
```bash
php bin/console cache:clear
php bin/console cache:pool:prune
php bin/console cache:warmup
```
If you don’t see any changes, then it’s possible that master is behind another branch containing the new code. If this is the case, you’ll need to merge that branch into master before pulling. If you don’t see any changes, then it’s possible that master is behind another branch containing the new code. If this is the case, you’ll need to merge that branch into master before pulling.
Merging branches can get messy and complicated quickly to new Git users, so it will not be explained here. Best practice dictates no changes should ever be made directly to master so it is highly recommended to learn some Git basics before modifying any code. Merging branches can get messy and complicated quickly to new Git users, so it will not be explained here. Best practice dictates no changes should ever be made directly to master so it is highly recommended to learn some Git basics before modifying any code.
# Content Management # Content Management
Changing page contents is mostly handled within special configuration files. Changes made to these files are reflected immediately upon saving. Changing page contents is mostly handled within special configuration files. Changes made to these files are reflected immediately upon saving.
If you’ve chosen to deploy using Git, it’s important to know that changes made to production files may be overwritten during the next pull if they’re not committed. See the section [Committing Changes to Git](##committing-changes-to-git) for advice on persisting these. If you’ve chosen to deploy using Git, it’s important to know that changes made to production files may be overwritten during the next pull if they’re not committed. See the section [Committing Changes](#committing-changes) for advice on persisting these.
## Main page ## Main page
Portal Content on the main page is generated from the `portalLinks.yaml` file in the `%project_dir%/config` folder. Portal Content on the main page is generated from the `portalLinks.yaml` file in the `%project_dir%/config` folder.
@ -194,7 +193,7 @@ Each question/answer object is keyed by a unique string, such as Question_1, Q2,
**Choices:** Answer options for the question go here. **Choices:** Answer options for the question go here.
**Label:** The text that’s displayed to represent the selection **Label:** The text that’s displayed to represent the selection
**Value:** A True/false determining if this is the correct answer or not. **Value:** A True/false determining if this is the correct answer or not.
## Committing Changes to Git ## Committing Changes
Changes made to production code will have to be discarded before any updates can be pulled from the upstream repository that modify those changed files. In case the production repo has to be restored, these changes will also be lost unless they’re committed and pushed upstream. Changes made to production code will have to be discarded before any updates can be pulled from the upstream repository that modify those changed files. In case the production repo has to be restored, these changes will also be lost unless they’re committed and pushed upstream.
In the interest of simplicity, this section will describe the process for committing changes directly to master. This goes against best practice, but will be fine for page config changes. In the interest of simplicity, this section will describe the process for committing changes directly to master. This goes against best practice, but will be fine for page config changes.
@ -208,9 +207,10 @@ In the interest of simplicity, this section will describe the process for commit
|`git pull` | Pulls pending changes from upstream. ALWAYS do this before a push| |`git pull` | Pulls pending changes from upstream. ALWAYS do this before a push|
|`git push` | Updates upstream origin with the changes made.| |`git push` | Updates upstream origin with the changes made.|
## Git – Reverting Changes ## Reverting Changes
To restore production to the current upstream branch (undoing any changes made locally) use this command To restore production to the current upstream branch (undoing any changes made locally) use this command
```git ```git
git restore git restore
``` ```
All changes that have not been committed will be discarded. All changes that have not been committed will be discarded.
If you need to revert something that has already been committed, that will not be covered here as it is beyond scope of this document.