From 1d4c600a6eb86f742d90481d081d9901fadc3a58 Mon Sep 17 00:00:00 2001 From: Wesley B <62723358+wesleyboar@users.noreply.github.com> Date: Thu, 10 Aug 2023 15:18:06 -0500 Subject: [PATCH] docs(README): clarify settings_local dir & "0 static assets" (#192) --- README.md | 7 +++---- apcd-cms/README.md | 2 +- demdata_cms/README.md | 2 +- example_cms/README.md | 2 +- matcssi_cms/README.md | 2 +- tapisproject_cms/README.md | 2 +- 6 files changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4367ed9f..936d3cfc 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Set up a new local CMS instance. 0. Core CMS: - In the `custom_project_dir/` you will run, create a `settings_local.py` with content from [Core-CMS `settings_local.example.py`](https://github.com/TACC/Core-CMS/blob/main/taccsite_cms/settings_local.example.py). + In the `/custom_project_dir/` you will run, create a `./src/taccsite_cms/settings_local.py` with content from [Core-CMS `settings_local.example.py`](https://github.com/TACC/Core-CMS/blob/main/taccsite_cms/settings_local.example.py). 1. Docker Containers: @@ -78,9 +78,6 @@ Set up a new local CMS instance. # To use default "Username" and skip "Email address", press Enter at both prompts. # At "Password" prompts, you may use an easy-to-remember password. python manage.py collectstatic --no-input - # If the project has no static assets, - # (and you have not set up other projects) - # then expect output of "0 static files […]" ``` 3. Django CMS: @@ -116,6 +113,8 @@ Update an existing local CMS instance. # That opens a command prompt within the container. python manage.py migrate python manage.py collectstatic --no-input + # If the project has no new/changed assets, + # then expect output of "0 static files […]" ``` [^1]: Pertinent changes are those in the Core CMS or the custom project. Changes to external assets or databases are not pertinent. diff --git a/apcd-cms/README.md b/apcd-cms/README.md index bc383d1d..f3f3b886 100644 --- a/apcd-cms/README.md +++ b/apcd-cms/README.md @@ -6,4 +6,4 @@ An extension of the [Core CMS](https://github.com/TACC/Core-CMS) project ## Basics -See [Core-CMS-Custom](https://github.com/TACC/Core-CMS-Custom#readme). +See [Core-CMS-Custom](../README.md). diff --git a/demdata_cms/README.md b/demdata_cms/README.md index baff71ba..e4e66e71 100644 --- a/demdata_cms/README.md +++ b/demdata_cms/README.md @@ -6,4 +6,4 @@ An extension of the [Core CMS](https://github.com/TACC/Core-CMS) project ## Basics -See [Core-CMS-Custom](https://github.com/TACC/Core-CMS-Custom#readme). +See [Core-CMS-Custom](../README.md). diff --git a/example_cms/README.md b/example_cms/README.md index dd1f815a..59a51232 100644 --- a/example_cms/README.md +++ b/example_cms/README.md @@ -4,4 +4,4 @@ An extension of the [Core CMS](https://github.com/TACC/Core-CMS) project ## Basics -See [Core-CMS-Custom](https://github.com/TACC/Core-CMS-Custom#readme). +See [Core-CMS-Custom](../README.md). diff --git a/matcssi_cms/README.md b/matcssi_cms/README.md index bb535159..d3118cd4 100644 --- a/matcssi_cms/README.md +++ b/matcssi_cms/README.md @@ -6,4 +6,4 @@ An extension of the [Core CMS](https://github.com/TACC/Core-CMS) project ## Basics -See [Core-CMS-Custom](https://github.com/TACC/Core-CMS-Custom#readme). +See [Core-CMS-Custom](../README.md). diff --git a/tapisproject_cms/README.md b/tapisproject_cms/README.md index dd1f815a..59a51232 100644 --- a/tapisproject_cms/README.md +++ b/tapisproject_cms/README.md @@ -4,4 +4,4 @@ An extension of the [Core CMS](https://github.com/TACC/Core-CMS) project ## Basics -See [Core-CMS-Custom](https://github.com/TACC/Core-CMS-Custom#readme). +See [Core-CMS-Custom](../README.md).