updated instructions to include both CLI and web
This commit is contained in:
parent
c49a7c0c62
commit
6cb13f3af8
1 changed files with 56 additions and 8 deletions
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: "Archetypes & content creation instructions 🦺 ⛏"
|
||||
title: "Content creation instructions & Archetypes 🦺"
|
||||
date: "2023-07-13T14:12:58+03:00"
|
||||
author: "anybody"
|
||||
draft: true
|
||||
has_articles: ["int-archetype-issue.md", "int-archetype-article.md", "int-archetype-contributor.md", "int-archetype-editor.md","int-archetype-print.md"]
|
||||
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
|
||||
|
@ -12,13 +12,22 @@ abstract: |
|
|||
Leave `draft:true`
|
||||
---
|
||||
|
||||
Please make sure to follow  for file names, and instructions for .
|
||||
# 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, and
|
||||
- the instructions for .
|
||||
|
||||
*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.
|
||||
|
||||
Each newly created item:
|
||||
- is set to draft (`draft: true`), meaning that it's not public/published;
|
||||
- is created after its corresponding archetype (found in `root/archetypes/`);
|
||||
- includes a list of required steps for preparing the entry for publication (copied in the articles of this isse);
|
||||
- will have two emojis in its title.[^emj] These are used to track new items, draft items, WIP items, and items potentially created by mistake. Creating a new item will have both the draft emoji ⚫, and the emoji associated with the particular content type, as per the table below:
|
||||
|
||||
| Emoji | Description |
|
||||
|-|-|
|
||||
|
@ -32,3 +41,42 @@ Each newly created item:
|
|||
<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.
|
||||
|
||||

|
||||
|
|
Loading…
Add table
Reference in a new issue