Skip to content

Commit

Permalink
docs(README): clarify settings_local dir & "0 static assets" (#192)
Browse files Browse the repository at this point in the history
  • Loading branch information
wesleyboar committed Aug 10, 2023
1 parent 24d648c commit 1d4c600
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 9 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion apcd-cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion demdata_cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion example_cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion matcssi_cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion tapisproject_cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit 1d4c600

Please sign in to comment.