Skip to content

Improve Onboarding / Sync with Core-CMS-Template #34

@wesleyboar

Description

@wesleyboar

I suggest this repo update its Core-CMS-Template framework.

Changes to Core-CMS-Template improve onboarding (see steps 2.3, 3.6+).

Important

Updating to v0.7+ requires updating Dockerfile CMS version to v4.37.0.

The changes would be manual.1

  1. Do not update:

    1. docs/*
    2. .github/
    3. .gitignore
      Unless you commit settings_custom.py (see step 3.3).
  2. Do update/add:

    1. README.md (bottom of file, version updates)
    2. cms/Makefile
    3. cms/bin/
    4. cms/docker-compose.dev.yml
    5. cms/src/taccsite_cms/settings/README.md
    6. cms/src/taccsite_cms/settings/settings_default.py
  3. Also:

    1. Move settings_local.py settings to settings/settings_default.py.
    2. Tell devs to empty their settings_local.py of previously prescribed values.
    3. Tell devs to move their …/settings_* and …/secrets.py to …/settings/*.py.
    4. Consider committing settings_custom.py. If you do, then update .gitignore.
    5. Verify Dockerfile CMS version is at least v4.37.0.
    6. Update README.md step for make start to be make setup.
    7. Delete README.md bullet about empty directories to be make setup.
      This bug is fixed with make setup.
    8. Delete README.md bullet about settings_local.py.

Footnotes

  1. This could be automatic/easier if clients, like APCD-CMS, were a fork, but I currently believe a fork brings more trouble than it provides for such a lightweight framework. You are welcome to convince me otherwise.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions