Content Management: Content creation, Archetypes & Associations (this will be internal) 🦺

1. 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 article⁄Content creation via the terminal), which requires a local clone of the repository, and will instantiate a new file according to §⁄archetypes; and
• online via the Sandpoints preview page (see article⁄Content creation via online preview site), which only requires repository access, and will create new empty files.

In either case, make sure to:

• follow §⁄file naming conventions and the §⁄instructions provided in the archetypes or archetype article templates, and
• provide adequate commit messages for any additions or modifications.

For parenting and associating content see article⁄Parenting and Associating entries.

2. Filename conventions and instructions for creating new entries¶

File naming:

• All lowercase
• Use dash as separator
• No spaces
• No underscores

Examples and instructions per entry type:

3. 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.

4. Title emojis¶

It is recommended to use emojis¹ 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.