Cleanup after cloned content method
This commit is contained in:
@@ -1,110 +1,54 @@
|
||||
# CTAO Science Portal — simple proof of concept
|
||||
# CTAO Science Portal
|
||||
|
||||
The `main` branch uses the sibling `mockup` project's layout, assets, CSS,
|
||||
and header interactions. Astro generates a static site. Sveltia CMS edits
|
||||
exactly four Markdown pages in the separate `ctao/content` repository.
|
||||
Static Astro site with a git-based CMS (Sveltia). Code lives here; editorial
|
||||
content lives in the separate [`ctao/content`](https://astro-git.isl-dev.grid.cyfronet.pl/ctao/content)
|
||||
repository. Four Example pages are editable; all other pages are placeholders.
|
||||
|
||||
## Scope
|
||||
|
||||
| Example submenu | URL | Content file |
|
||||
|---|---|---|
|
||||
| Lorem ipsum | `/example/lorem-ipsum/` | `pages/lorem-ipsum.md` |
|
||||
| Dolor sit amet | `/example/dolor-sit-amet/` | `pages/dolor-sit-amet.md` |
|
||||
| Consectetur adipiscing | `/example/consectetur-adipiscing/` | `pages/consectetur-adipiscing.md` |
|
||||
| Sed do eiusmod | `/example/sed-do-eiusmod/` | `pages/sed-do-eiusmod.md` |
|
||||
|
||||
Home, News, Data, Proposals, Dashboard, Sign in, Search, Support, Privacy,
|
||||
Disclaimer, and Contact have the shared header/footer, a title, and an empty
|
||||
body. Search submits to its placeholder. Only English is available; the
|
||||
other language options are inactive. There are no news articles, news
|
||||
pagination, RSS feeds, search index, service integrations, or public sign-in.
|
||||
`/admin/` remains the working CMS entry point.
|
||||
- Live demo: https://astro.isl-dev.grid.cyfronet.pl
|
||||
- Editor: https://astro.isl-dev.grid.cyfronet.pl/admin/ (Gitea sign-in)
|
||||
|
||||
## Run locally
|
||||
|
||||
Use Node 22.19 or newer (deployment uses Node 24).
|
||||
Node 22.19 or newer. Clone the content repository next to this one:
|
||||
|
||||
```sh
|
||||
git clone https://astro-git.isl-dev.grid.cyfronet.pl/ctao/content.git ../content
|
||||
npm ci
|
||||
npm run dev
|
||||
npm run dev # http://localhost:4321
|
||||
```
|
||||
|
||||
Open `http://localhost:4321/example/lorem-ipsum/` for the full mockup example.
|
||||
The first run copies bundled `sample-content/pages/` and `uploads/` into the
|
||||
ignored runtime directories. Existing content is preserved. An incomplete
|
||||
existing set fails with a missing-file error instead of silently mixing
|
||||
sample content with editorial content.
|
||||
The site reads `../content` directly through links, so pull that repository
|
||||
for the latest content. To use a checkout elsewhere:
|
||||
`npm run content:link -- <path>`.
|
||||
|
||||
```sh
|
||||
npm run content:setup # explicitly restore the four sample pages
|
||||
npm run content:sync -- ../ctao-content # copy from a separate content checkout
|
||||
npm run check # types, static build, internal links
|
||||
npm run build
|
||||
npm run preview # inspect the built site
|
||||
```
|
||||
Before pushing code, run `npm run check` (types, build, internal links).
|
||||
|
||||
`content:setup` and `content:sync` replace the four runtime Markdown files and
|
||||
copy uploads, overwriting same-named media. They do not modify the source
|
||||
content checkout. Only the four allowlisted pages are loaded and rendered;
|
||||
unrelated Markdown files never create public routes.
|
||||
## Edit content locally
|
||||
|
||||
## Edit with Sveltia locally, without Gitea
|
||||
With `npm run dev` running, open `http://localhost:4321/admin/` in Chrome or
|
||||
Edge, choose **Work with Local Repository** and select the `../content` folder.
|
||||
Saves write the Markdown files and show up on the local site on reload. They
|
||||
are not committed: commit and push in `../content` to publish.
|
||||
|
||||
```sh
|
||||
npm run content:local
|
||||
npm run dev
|
||||
```
|
||||
## Publishing
|
||||
|
||||
In Chrome or Edge, open `/admin/`, select **Work with Local Repository**, and
|
||||
choose this project's `.tmp/content` directory. The setup command creates a
|
||||
local Git repository there, seeded from the bundled content. Re-running it
|
||||
preserves edits in that directory.
|
||||
|
||||
Save an Example page, then run this in another terminal to refresh the site:
|
||||
|
||||
```sh
|
||||
npm run content:sync -- .tmp/content
|
||||
```
|
||||
|
||||
The local editor writes files without committing them. This follows
|
||||
[Sveltia's local workflow](https://sveltiacms.app/en/docs/workflows/local).
|
||||
Choose the content repository root, not the portal code repository root:
|
||||
the CMS expects `pages/` and `uploads/` directly beneath it.
|
||||
|
||||
## Content and publishing
|
||||
|
||||
The CMS uses a [fixed file collection](https://sveltiacms.app/en/docs/collections/files).
|
||||
Editors can change title, introduction, optional image/alternative text/caption,
|
||||
Markdown body, and optional button label/destination. Both button fields are
|
||||
needed to display the button. A Markdown blockquote receives the mockup's
|
||||
highlight styling. Images without alternative text are treated as decorative.
|
||||
Menu labels, ordering, URLs, and the shared site layout remain code-controlled.
|
||||
|
||||
Remote editing uses Gitea OAuth and saves to **`ctao/content`, branch `main`**.
|
||||
That branch must contain the four files from `sample-content/pages/` and the
|
||||
sample upload before publishing this version. The code mirror is
|
||||
**`ctao/portal`, branch `main`**. Deployment independently selects
|
||||
`CODE_BRANCH` and `CONTENT_BRANCH`, overlays content, runs checks, and publishes
|
||||
atomically. `CONTENT_BRANCH` must match `backend.branch` in the CMS config.
|
||||
|
||||
See [deploy/README.md](deploy/README.md) for migration and publishing steps.
|
||||
A push to Bitbucket alone does not deploy the site.
|
||||
Pushing to `main` of `ctao/portal` (code) or `ctao/content` (content) on
|
||||
Gitea rebuilds and publishes the live demo automatically; the online editor
|
||||
commits to `ctao/content` directly. Pushing to Bitbucket does not deploy.
|
||||
Server setup is in [deploy/README.md](deploy/README.md).
|
||||
|
||||
## Where things live
|
||||
|
||||
| Path | Purpose |
|
||||
|---|---|
|
||||
| `src/layouts/Base.astro` | Mockup header, navigation, footer, page shell |
|
||||
| `src/components/PageHero.astro` | Breadcrumb, title, introduction, nebula |
|
||||
| `src/pages/example/[slug].astro` | One reusable editable-page template |
|
||||
| `src/data/examples.json` | Fixed submenu labels, order, and slugs |
|
||||
| `src/data/placeholders.json` | Empty destinations |
|
||||
| `src/styles/global.css` | Mockup styles plus Markdown/placeholder variants |
|
||||
| `public/assets/`, `public/header.js` | Mockup assets and menu behavior |
|
||||
| `sample-content/` | Versioned seed content for local use and Gitea setup |
|
||||
| `src/content/pages/`, `public/uploads/` | Ignored runtime content overlay |
|
||||
| `public/admin/config.yml` | Four fixed CMS files and Gitea configuration |
|
||||
| `scripts/preview-styles.mjs` | Generates CMS body preview styles from site CSS |
|
||||
| `src/layouts/Base.astro` | Header, navigation, footer, page shell |
|
||||
| `src/pages/example/[slug].astro` | Template for the editable Example pages |
|
||||
| `src/data/examples.json` | Example pages: menu labels, order, slugs |
|
||||
| `src/data/placeholders.json` | Placeholder pages |
|
||||
| `src/styles/global.css` | All site styles |
|
||||
| `public/admin/config.yml` | CMS fields and Gitea connection |
|
||||
| `scripts/preview-styles.mjs` | Builds the CMS preview styles from `global.css` |
|
||||
| `scripts/content.mjs` | Links the content checkout into the site |
|
||||
|
||||
The vendored CMS bundle remains in `public/vendor/sveltia-cms.js`. Dependencies
|
||||
remain pinned; this simplification adds no application dependencies.
|
||||
To add an Example page, add it to `src/data/examples.json` and
|
||||
`public/admin/config.yml`, and commit its Markdown file to `ctao/content`.
|
||||
|
||||
Reference in New Issue
Block a user