Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ The base CMS code for TACC WMA Workspace Portals & Websites
| `bin` | scripts e.g. build CSS |
| `taccsite_cms` | settings for [Core CMS] |
| `taccsite_custom` | [Git submodule][Git Submodules] of [Core CMS Resources] |
| `taccsite_ui` | files to build [TACC UI Patterns] |

## Prerequisites

Expand Down Expand Up @@ -140,8 +139,7 @@ To only update as necessary, or update since uncommon changes:
| 1 | Python models | `docker exec -it core_cms sh -c "python manage.py migrate"` |
| 2 | Node dependencies | `npm ci` |
| 3 | CSS stylesheets | `npm run build:css` |
| 4 | UI Demo | `npm run build:ui-demo` |
| 5 | Assets e.g.<br><sub>images, stylesheets, JavaScript, UI demo</sub> | `docker exec -it core_cms sh -c "python manage.py collectstatic --no-input"` |
| 4 | Assets e.g.<br><sub>images, stylesheets, JavaScript</sub> | `docker exec -it core_cms sh -c "python manage.py collectstatic --no-input"` |

</details>

Expand Down Expand Up @@ -193,7 +191,6 @@ To contribute, first read [How to Contirbute][Contributing].
[Docker]: https://docs.docker.com/get-docker/
[Docker Compose]: https://docs.docker.com/compose/install/

[TACC UI Patterns]: https://tacc.utexas.edu/static/ui/
[Build & Deploy Project]: https://tacc-main.atlassian.net/wiki/x/2AVv
[Django CMS User Guide]: https://tacc-main.atlassian.net/wiki/x/phdv

Expand Down
28 changes: 14 additions & 14 deletions docs/develop-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Read [Django CMS User Guide] for CMS user instructions.
- [Build Static Files](#build-static-files)
- [Collect Static Files](#collect-static-files)
- [Customize & Translate Text](#customize--translate-text)
- [Demo UI Patterns](#demo-ui-patterns)
- [Review Patterns from Core Styles](#review-patterns-in-core-styles)
- [Develop with Core Styles Simultaneously](#develop-with-core-styles-simultaneously)

## Add Styles & Scripts
Expand Down Expand Up @@ -82,27 +82,27 @@ docker exec -it core_cms sh -c "python manage.py collectstatic --no-input"

4. [Restart the CMS server.][restart server]

## Demo UI Patterns
## Review Patterns in Core Styles

A demo of any documented CSS modules from [Core Styles] and [Core CMS].
### For Latest Patterns & Styles

1. Build:
See https://tacc.github.io/Core-Styles.

```sh
npm run build:ui-demo
```
### For Patterns & Styles as of Your CMS Version:

2. [Collect Static Files](#collect-static-files):

```sh
docker exec -it core_cms sh -c "python manage.py collectstatic --no-input"
0. See current version of Core Styles installed:
```shell
npm list @tacc/core-styles
```

3. Open http://localhost:8000/static/ui/index.html.
1. Checkout [Core Styles] at that version, e.g.:
```shell
git checkout v2.43.1
```
2. Follow [Core Styles "Quick Start"](https://github.com/TACC/Core-Styles/blob/v2.43.2/README.md#quick-start) up to `npm start`.

## Develop with [Core Styles] Simultaneously

See [Locally Develop CMS and Styles](https://github.com/TACC/Core-CMS/wiki/Locally-Develop-CMS-and-Styles).
See [Locally Develop CMS and Styles](https://github.com/TACC/Core-Styles/wiki/Develop-with-Client-Code-Simultaneously).

<!-- Link Aliases -->

Expand Down
Loading