70 lines
3.9 KiB
Markdown
70 lines
3.9 KiB
Markdown
|
---
|
|||
|
|
title: "Content Management: Content creation, Archetypes & Associations (this will be internal) 🦺"
|
|||
|
|
date: "2023-07-13T14:12:58+03:00"
|
|||
|
|
author: "anybody"
|
|||
|
|
draft: false
|
|||
|
|
has_articles: ["int-content-online.md","int-content-cli.md","int-parenting.md","int-archetype-issue.md", "int-archetype-article.md", "int-archetype-contributor.md", "int-archetype-editor.md","int-archetype-print.md"]
|
|||
|
|
keywords:
|
|||
|
|
- internal
|
|||
|
|
- guide
|
|||
|
|
abstract: |
|
|||
|
|
This contains archetypes for creating content, as they can be found at `/root/archetypes/`
|
|||
|
|
Leave `draft:true`
|
|||
|
|
---
|
|||
|
|
# Content creation workflows
|
|||
|
|
|
|||
|
|
There are two main workflows for creating new content (new Markdown files). Both workflows make use of Git commits, and require write access to the project repository. These are:
|
|||
|
|
- **via the terminal** (see ), which requires a local clone of the repository, and will instantiate a new file according to [archetypes](#archetypes); and
|
|||
|
|
- **online via the Sandpoints preview page** (see ), which only requires repository access, and will create *new empty files*.
|
|||
|
|
|
|||
|
|
In either case, make sure to:
|
|||
|
|
- follow [file naming conventions](#filenames) and the [instructions](#archetypes) provided in the archetypes or archetype article templates, and
|
|||
|
|
- provide adequate commit messages for any additions or modifications.
|
|||
|
|
|
|||
|
|
For parenting and associating content see .
|
|||
|
|
# Filename conventions and instructions {#filenames}
|
|||
|
|
|
|||
|
|
- All **lowercase**
|
|||
|
|
- Use **dash as separator**
|
|||
|
|
- No spaces
|
|||
|
|
- No underscores
|
|||
|
|
|
|||
|
|
| Type | Filename convention | Instructions template (archetype) |
|
|||
|
|
|-|-|-|
|
|||
|
|
| contributor | name-surname.md | |
|
|||
|
|
| editor | name-surname.md ||
|
|||
|
|
| issue (x is number) | issue-x.md | |
|
|||
|
|
| article | article-short-title.md |  |
|
|||
|
|
| print | p-issue-x.md |  |
|
|||
|
|
<figcaption>Table 1: Filename conventions and instructions per content type.</figcaption>
|
|||
|
|
|
|||
|
|
|
|||
|
|
# Archetypes {#archetypes}
|
|||
|
|
|
|||
|
|
Archetypes are template files for new content. However, these are only taken into account when new content is created via the terminal (not via the preview page).
|
|||
|
|
Archetypes are located at the directory `/root/archetypes/` which includes one Markdown file per content type (i.e. `issue.md`, `article.md`, etc.).
|
|||
|
|
|
|||
|
|
The archetypes include a list of instructions, per content type, for properly creating, editing, and committing new content. These instructions are included in new content created via the terminal.
|
|||
|
|
|
|||
|
|
The same instructions are also provided in the contents of this issue (see articles linked in Table 1), which can be copied to new entries created via the preview page.
|
|||
|
|
# Title emojis {#emojis}
|
|||
|
|
|
|||
|
|
It is recommended to use emojis[^emj] in the title of any new and WIP items, to keep track of unpublished content as well as potential mistakes.
|
|||
|
|
Each new item created from archetypes (via the terminal) will feature two emojis: one to signal a draft (⚫) and a second one associated its particular content type (e.g. 📕📑🧜♕🖶☮). It's recommended to keep at least the draft emoji as long as an item is in preparation.
|
|||
|
|
The table below describes the logic of emojis used.
|
|||
|
|
|
|||
|
|
|
|||
|
|
| Emoji | Description |
|
|||
|
|
|-|-|
|
|||
|
|
|⚫| draft/WIP entry (included in all new items; removed only when the article is ready for publishing)|
|
|||
|
|
|📕| new issue entry|
|
|||
|
|
|📑| new article entry|
|
|||
|
|
|🧜| new contributor entry|
|
|||
|
|
|♕| new editor entry |
|
|||
|
|
|🖶| new print entry|
|
|||
|
|
|☮| new journal entry (!do not create new journal entries!)|
|
|||
|
|
<figcaption>Table 2: Descriptions of emojis placed in the title of new entries.</figcaption>
|
|||
|
|
|
|||
|
|
[^emj]: Emojis found at https://www.compart.com/en/unicode/
|
|||
|
|
|