Skip to content

Commit

Permalink
11698 cbyrd update 7.6.0 documentation (#11699)
Browse files Browse the repository at this point in the history
* updates 7.6.0 documentation project upgrade instructions #11698
chrabyrd authored Dec 19, 2024
1 parent fd21901 commit 4db35d4
Showing 2 changed files with 44 additions and 16 deletions.
59 changes: 43 additions & 16 deletions releases/7.6.0.md
Original file line number Diff line number Diff line change
@@ -565,38 +565,65 @@ Minor incompatibilities:
pre-commit install
```
17. Navigate to the directory with your project's package.json file. Then run:
17. Run system checks against your production settings.
Note: This command not only performs essential system checks but also generates the frontend configuration file required for your application. It is a crucial step in the deployment process and must be executed to ensure that the environment is correctly configured.
```
python manage.py check --deploy --settings=path.to.production.settings
```
18. Navigate to the directory with your project's package.json file. Then run:
```
npm install
```
18. Start your application server in a separate terminal if it's not already running.
19. Start your application server in a separate terminal if it's not already running.
19. In the same terminal window where you ran `npm` ( on the same level as `package.json` ):
20. In the same terminal window where you ran `npm` ( on the same level as `package.json` ):
1. If it hasn't been run previously, run:
```
python manage.py check --deploy --settings=path.to.production.settings
```
This command will ensure the `.frontend-configuration-settings.json` file is created, which is necessary for building the static asset bundle.
1. Run `npm run gettext:extract` followed by `npm run gettext:compile`. This will generate i18n files in your `locale` directory. Even if you're
2. Run
```
npm run gettext:extract
npm run gettext:compile
```
This will generate i18n files in your `locale` directory. Even if you're
not planning on internationalizing your project, it's important to have these files for creating Vue components.
2. Run `npm start` or `npm run build_development`. This will generate your `media/build` directory.
3. Build your frontend asset bundle:
- If running your project in development:
- `npm start` will build the frontend of the application and then start a webpack development server
- `npm run build_development` will build a development bundle for the frontend assests of the application -- this should complete in less than 2 minutes
- If you plan on doing active development, and need to see frontend changes automatically, run:
```
npm start
```
This will build a development static asset bundle for the application and then start a webpack development server.
- If you do not plan to do active development, run:
```
npm run build_development
```
This will build a development static asset bundle for the application.
Either process should complete in less than 2 minutes.
- If running your project in production:
- `npm run build_production` This builds a production bundle. **takes up to 2hrs depending on resources**
- Alternatively you can run `python manage.py build_production`. This will create a production bundle of frontend assets and also call `collectstatic`.
```
npm run build_production
```
This will build a production static asset bundle for the application. **takes up to 2 hours depending on resources**
20. Test your project with deprecation warnings enabled.
21. Test your project with deprecation warnings enabled.
```
python -Wall::DeprecationWarning manage.py test tests --settings=tests.test_settings
```
21. Run system checks against your production settings.
```
python manage.py check --deploy --settings=path.to.production.settings
```
22. Be sure that your web server has write access to the following files:
```
1 change: 1 addition & 0 deletions releases/7.6.4.md
Original file line number Diff line number Diff line change
@@ -11,6 +11,7 @@
- Fix for bug that prevents saving tab name changes in a tabbed report #[11617](https://github.com/archesproject/arches/issues/11617)
- Fix regression where Arches is no longer overriding Django admin templates #[11668](https://github.com/archesproject/arches/issues/11668)
- Fix bug causing app resources with symlink in their path to not resolve #[11689](https://github.com/archesproject/arches/issues/11689)
- Update 7.6.0 documentation to handle potential error with `generate_frontend_configuration` #[11698](https://github.com/archesproject/arches/issues/11698)
- Fix bug causing the Edit button to not display in the map popup #[11679](https://github.com/archesproject/arches/issues/11679)
- Fix enabling multiple languages if the `APP_NAME` system settings tile had never been updated #[11660](https://github.com/archesproject/arches/issues/11660)

0 comments on commit 4db35d4

Please sign in to comment.