Add Content Manager

.gitattributes

@@ -4,6 +4,7 @@
 *.json text
 *.js text linguist-detectable
 *.md text linguist-detectable
+*.ts text linguist-detectable
 *.{yml,yaml} text
 
 *.png binary

.github/workflows/deploy.yml

@@ -6,8 +6,12 @@ on:
         description: "The version of the website to deploy"
         type: string
         required: true
+      push_image:
+        description: "Push to remote. Disable to use an already pushed image with the same version"
+        type: boolean
+        default: true
       deploy_image:
-        description: "Push and deploy this image. Disable to build only"
+        description: "Deploy the image using this version to the server"
         type: boolean
         default: true
       send_webhook:
@@ -62,7 +66,7 @@ jobs:
         id: docker
         with:
           context: .
-          push: ${{ github.event.inputs.deploy_image }}
+          push: ${{ github.event.inputs.push_image }}
           # See https://github.com/docker/build-push-action/issues/535#issuecomment-1936723515
           tags: ${{ secrets.DOCKERHUB_USERNAME }}/${{ vars.DOCKERHUB_IMAGE_NAME }}:${{ github.event.inputs.version }}
   deploy:

.gitignore

@@ -9,6 +9,7 @@ node_modules
 /docs/.vitepress/dist/
 /docs/.vitepress/cache/
 /.vitepress/cache/
+/docs/.vitepress/public/admin/
 
 # Do not commit API keys
 .env

CONTRIBUTING.md

@@ -1,6 +1,27 @@
-# Overview
+# Workflow
 
-Contribution should be performed through a number of simple steps:
+Hi, we, the [guide maintainers](./README.md), are really exited that you are interested in contributing to this guide. Before contributing, decide what type of contribution you are looking to make:
+
+- [Writing guide pages](#content-editing).
+- Writing code. Before starting make sure to read:
+  - [The development workflow](#development)
+  - [The project guidelines](#guidelines)
+  - [Development setup guide](#development-and-local-testing)
+- Becoming a team member: send a message to Mr. Swaggles or ghostrider-05 on Discord
+
+## Content editing
+
+To make changes to the content of the guide, we recommend to use the CMS ([Content Management System](https://en.wikipedia.org/wiki/Content_management_system)), available on the [`/admin/`](https://rocketleaguemapmaking.com/admin/) path or by clicking the `Edit this page` link on a guide page, to make your contributions through the following steps:
+
+1. [Create a GitHub account](https://github.com/join)
+2. Log in using your GitHub account on the [guide CMS](https://rocketleaguemapmaking.com/admin/).
+3. Write guide pages while following [the guidelines](#guidelines).
+4. When finished, save your edited pages and go to [the workflow UI](https://rocketleaguemapmaking.com/admin/#/workflow) and move your changes to the `In Review` column.
+5. A maintainer will review your changes and merge the pull request on GitHub.
+
+## Development
+
+Code contributions should be performed through the following steps:
 
 1. Find an issue to fix.
 2. Fork the repository.
@@ -33,7 +54,7 @@ We have some minor style requirements for documentation additions:
   - Images should be added in `/docs/.vitepress/public/images/{section}/` and icons in `/docs/.vitepress/public/icons`.
   - Images and icons should have relevant file names to their content and be named in snake_case. Icons should also be prefixed by `logo_`.
   - Images are not allowed directly in `/images/`, `/images/blender/` and `/images/udk/`, only the subdirectories of those folders.
-  - Image references in markdown should [have a good alt text](https://supercooldesign.co.uk/blog/how-to-write-good-alt-text). They can also have [a title](https://www.markdownguide.org/basic-syntax/#images-1) with a comment or small joke. Images of icons don't need to have an alt text.
+  - Image references in markdown should [have a good alt text](https://webaim.org/techniques/alttext/). They can also have [a title](https://www.markdownguide.org/basic-syntax/#images-1) with a comment or small joke. <!-- Some image alt text may be redundant, but that is something for later to check -->
   - Images should have a line break (`---` with one white line above) between each other if no other text is between the images.
 - [Create an issue](https://github.com/rocketleaguemapmaking/RL-docs/issues/new/choose) for small contributions (such as fixing typos or broken links).
 
@@ -85,4 +106,4 @@ Furthermore, this repo has the following `pageClass`es available:
 
 The following components (not including the components registered by the theme) are also registered globally:
 
-- `DocFeatures`
+- [`DocFeatures`](https://theme-rlmm.pages.dev/components#docfeatures)

README.md

@@ -3,10 +3,10 @@
 
 # Rocket League Mapmaking Website Documentation
 
+[![GitHub package.json version](https://img.shields.io/github/package-json/v/rocketleaguemapmaking/rl-docs)][package.json]
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/RocketLeagueMapMaking/RL-docs/test.yml?branch=master&label=tests)][github-actions]
 [![Website](https://img.shields.io/website?down_message=offline&up_message=online&url=https%3A%2F%2Frocketleaguemapmaking.com%2F)][domain]
 [![Dev website](https://img.shields.io/website?down_message=offline&up_message=online&label=website@master&url=https%3A%2F%2Frocketleaguemapmaking.pages.dev%2F)][dev-domain]
-[![GitHub package.json version](https://img.shields.io/github/package-json/v/rocketleaguemapmaking/rl-docs)][package.json]
 
 - Guide by Mr Swaggles
 - Site design by ghostrider-05
@@ -22,7 +22,8 @@ This site can be executed as a docker container on the host machine.
 To update the site on the host machine, run [the `deploy` workflow](https://github.com/RocketLeagueMapmaking/RL-docs/actions/workflows/deploy.yml) on the default branch with the following inputs:
 
 - version: the version to deploy. Generally the same as the version in [package.json](./package.json).
-- deploy & push (default: `true`). Disable this to only build the Docker Image with deploying it.
+- push (default: `true`). Controls whether to push the built image to Docker hub. If `deploy` is enabled and `push` is disabled, the server will use an already pushed image with the same `version`, or fail.
+- deploy (default: `true`). Disable this to only build (and push) the Docker Image without deploying it.
 - webhook message (default: `true`): send a Discord message with the deployment details when the workflow is finished.
 
 See the GitHub documentation for [how to run a workflow manually](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow#running-a-workflow).  

docs/.vitepress/config/cms/blocks.ts

@@ -0,0 +1,52 @@
+import { DecapCmsField } from 'vite-plugin-decap-cms'
+
+type BlockFields = { summary?: string, contents: string, type: string }
+
+export const customContainerBlock = {
+    id: 'custom-block',
+    label: 'Custom block',
+    fields: [
+        {
+            name: 'type',
+            label: 'Type of block',
+            widget: 'select',
+            required: true,
+            options: [
+                'details',
+                'warning',
+                'danger',
+                'info',
+                'tip',
+                // Not a custom container, but has the same syntax
+                'raw',
+            ],
+        },
+        {
+            name: 'summary',
+            label: 'Summary',
+            required: false,
+            widget: 'string'
+        },
+        {
+            name: 'contents',
+            label: 'Contents',
+            required: true,
+            widget: 'markdown'
+        }
+    ] satisfies DecapCmsField[],
+    // @ts-expect-error Needs flag to work
+    pattern: /^:::(\w+)(.*?)\n(.*?)\n^:::$/ms,
+    fromBlock: function (match: RegExpMatchArray): BlockFields {
+        return {
+            type: match[1],
+            summary: match[2],
+            contents: match[3]
+        }
+    },
+    toBlock: function (data: BlockFields) {
+        return `:::${data.type} ${data.summary}\n${data.contents}\n:::`
+    },
+    toPreview: function (data: BlockFields) {
+        return `:::${data.type} ${data.summary}\n${data.contents}\n:::`
+    },
+}

docs/.vitepress/config/cms/collections.ts

@@ -0,0 +1,147 @@
+import { type PageData } from 'vitepress'
+import { type DecapCmsCollection } from 'vite-plugin-decap-cms'
+
+import sidebar, { type Sidebar } from '../sidebar'
+
+import {
+    createFeaturePageField,
+    createHomePageFields,
+    createSiteConfigFields,
+    createTeamPageField,
+} from './fields'
+
+import {
+    createAdvancedCollections,
+    createFileCollection,
+    createFolderCollection,
+} from './options'
+
+export const getCollectionItemEditLink = (page: Pick<PageData, 'filePath' | 'frontmatter'>) => {
+    const parts = page.filePath.slice(0, -'.md'.length).split('/')
+    const collectionName = parts.at(-2) + (page.frontmatter.advanced ? '_advanced' : ''), entryName = parts.at(-1)!
+
+    return `/admin/index.html#/edit/${collectionName}/${entryName}`
+}
+
+export default function (): DecapCmsCollection[] {
+    const sidebarItems = Object.values(<Sidebar>sidebar)
+
+    return [
+        createFileCollection('Special pages', [
+            {
+                name: 'Site configuration',
+                file: 'docs/.vitepress/config/data/config.json',
+                overwrites: {
+                    deleted: true,
+                },
+                additionalFields: createSiteConfigFields(),
+            },
+            {
+                name: 'Home page',
+                file: 'docs/index.md',
+                overwrites: {
+                    titleTemplate: { hidden: true },
+                    head: { hidden: true },
+                    body: { required: false },
+                },
+                additionalFields: createHomePageFields(),
+            },
+        ], {
+            collection: {
+                create: false,
+                delete: false,
+                publish: false,
+            },
+        }),
+        createFileCollection('Special keys', [
+            {
+                name: 'About: teams & special thanks',
+                file: 'docs/more/about.md',
+                overwrites: {
+                    hidden: true,
+                },
+                additionalFields: [
+                    createTeamPageField(),
+                ]
+            },
+            {
+                name: 'Features: map test - collision types',
+                file: 'docs/guide/udk/04_map_test.md',
+                overwrites: {
+                    hidden: true,
+                },
+                additionalFields: [
+                    createFeaturePageField({
+                        name: 'collision_types',
+                        label: 'Collision types',
+                        label_singular: 'type',
+                    }),
+                ],
+            },
+            {
+                name: 'Features: building - next actions',
+                file: 'docs/guide/udk/06_owl.md',
+                overwrites: {
+                    hidden: true,
+                },
+                additionalFields: [
+                    createFeaturePageField({
+                        name: 'next_actions',
+                        label: 'Next actions',
+                        label_singular: 'action',
+                    }),
+                ],
+            },
+        ], {
+            collection: {
+                create: false,
+                delete: false,
+                publish: false,
+            },
+        }),
+
+        ...sidebarItems
+            .filter(({ base }) => base === '/guide/')
+            .flatMap(({ items, meta }) => {
+                return items.flatMap(item => {
+                    const dirname = item.base!.replace('/guide/', '').slice(0, -1)
+
+                    if (dirname === 'udk') {
+                        return createAdvancedCollections((type) => ({
+                            base: item.base!,
+                            name: dirname,
+                            mediaFolder: dirname + '/',
+                            label: meta.text! + ': Editor' + (type === 'advanced' ? ' advanced' : ''),
+                            description: item.text! + ' ' + type + ' guide pages',
+                        }))
+                    }
+
+                    return createFolderCollection({
+                        base: item.base!,
+                        name: dirname,
+                        label: meta.text! + ': ' + item.text!,
+                        description: item.text! + ' guide pages',
+                        mediaFolder: dirname + '/',
+                    })
+                })
+            }),
+
+        ...createAdvancedCollections((type) => ({
+            base: '/guide/blender/',
+            name: 'blender',
+            mediaFolder: `blender/${type}/`,
+            label: 'Blender' + (type === 'advanced' ? ': advanced' : ''),
+            description: `Blender ${type} guide pages`,
+        })),
+
+        ...sidebarItems
+            .filter(({ base }) => !base.startsWith('/guide/'))
+            .flatMap(({ items, base, meta: config }) => {
+                return createFolderCollection({
+                    base,
+                    label: config.text ?? items[0].text!,
+                    mediaFolder: '',
+                })
+            }),
+    ]
+}