Changed archetypes issue to content-management; add print; made public
This commit is contained in:
parent
d624d11b59
commit
e6bbcb2499
3 changed files with 77 additions and 83 deletions
|
|
@ -1,83 +0,0 @@
|
|||
---
|
||||
title: "Content creation instructions & Archetypes 🦺"
|
||||
date: "2023-07-13T14:12:58+03:00"
|
||||
author: "anybody"
|
||||
draft: true
|
||||
has_articles: ["int-content.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`
|
||||
---
|
||||
|
||||
# Creating new content: Introduction
|
||||
There are two main ways for creating new content:
|
||||
- either *via the terminal*, which requires a local working clone of the repository, and will instantiate a new file according to archetypes (see [via the terminal](#cli)), or
|
||||
- *online via the Sandpoints preview page*, which only requires repository access, and will create *new empty files* (see [via online preview page](#online)).
|
||||
|
||||
In either case, make sure to follow:
|
||||
- the  for file names,
|
||||
- the instructions for , and
|
||||
- provide adequate commit messages.
|
||||
|
||||
*Note: both workflows require write access to the project repository.*
|
||||
# Title emojis {#emojis}
|
||||
|
||||
It is recommended to use emojis[^emj] in the title of any new or in progress entries so as to keep track of new and WIP items as well as potential mistakes.
|
||||
Each new item created via the archetypes (via the terminal) will feature two emojis: one to signal a draft (⚫) and a second one associated its particular content type (e.g. 📕📑🧜♕🖶☮).
|
||||
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>Descriptions of emojis placed in the title of new entries.</figcaption>
|
||||
|
||||
[^emj]: Emojis found at https://www.compart.com/en/unicode/
|
||||
|
||||
# New content via the terminal {#cli}
|
||||
|
||||
If created via the terminal, each newly created item:
|
||||
- is created after its corresponding archetype (found in `root/archetypes/`);
|
||||
- is set to draft (`draft: true`), meaning that it's not public/published;
|
||||
- includes a list of required steps for preparing the entry for publication (copied in the articles of this issue);
|
||||
- will have two emojis in its title (see [title emojis](#emojis)).
|
||||
|
||||
*Note: this workflow requires a local clone of the repository as well as a Hugo installation, in addition to repository credentials.*
|
||||
# New content via the online Sandpoints preview page {#online}
|
||||
|
||||
The project preview page allows for both creating new entries and also editing existing entries. To access the preview page append `/_preview/` to the root (sitemap) URL.
|
||||
|
||||
*Note: Creating new items does not make use of archetypes. Any new item created with this workflow will be created empty, and will require a YAML header to work.*
|
||||
## Preview site interface
|
||||
|
||||
The preview site features a toolbar with five options (Screenshot 1), explained in the table below.
|
||||
|
||||
|
||||
|
||||
|
||||
|Preview site options|
|
||||
|-|-|
|
||||
| EDIT_THIS | edit the current page |
|
||||
| ADD_JOURNAL / ADD_ISSUE / ADD_ARTICLE | create new entry by type|
|
||||
| PUBLISH | recompile the website to include any unpublished changes |
|
||||
| ? | open the repository website |
|
||||
|
||||
## Online editing & new item creation
|
||||
All modifications (edits or new items) are carried out as git commits (Screenshots 2 and 3).
|
||||
|
||||
|
||||
|
||||
|
||||
Note that adding a new item will create a new empty Markdown document, which is also missing the required YAML header (Screenshot 3).
|
||||
For creating new items it is strongly recommended to start with a copy of archetype corresponding to the specific type of item you are creating, found in the 'archetype' contents of this issue. These include the required instructions to follow as well as sample YAML headers to start with.
|
||||
|
||||
|
||||
69
content/issue/int-issue-content-management.md
Normal file
69
content/issue/int-issue-content-management.md
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
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/
|
||||
|
||||
8
content/print/p-issue-content-management.md
Normal file
8
content/print/p-issue-content-management.md
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: "Print Content Management Issue (internal)"
|
||||
date: "2023-07-12T01:43:17+03:00"
|
||||
author: "anybody"
|
||||
draft: false
|
||||
print: "issue/int-issue-content-management.md"
|
||||
keywords: [print]
|
||||
---
|
||||
Loading…
Add table
Reference in a new issue