From a8316acf3025aba7aa824cd8eae181c3f99ebac5 Mon Sep 17 00:00:00 2001 From: constantinos Date: Tue, 15 Aug 2023 18:47:24 +0300 Subject: [PATCH] made public; finalized instructions --- content/article/int-archetype-article.md | 25 ++++++++--------- content/article/int-archetype-contributor.md | 26 +++++++++--------- content/article/int-archetype-editor.md | 26 ++++++++---------- content/article/int-archetype-issue.md | 28 +++++++++---------- content/article/int-archetype-print.md | 29 ++++++++++---------- 5 files changed, 65 insertions(+), 69 deletions(-) diff --git a/content/article/int-archetype-article.md b/content/article/int-archetype-article.md index 646366e..d778773 100644 --- a/content/article/int-archetype-article.md +++ b/content/article/int-archetype-article.md @@ -3,28 +3,27 @@ title: "New Article Archetype 📑" date: "2023-07-13T14:15:10+03:00" author: "anybody" contributors: ["constantinos-miltiadis.md"] -draft: true +draft: false keywords: - archetype - internal - guide abstract: | - This is a copy of the archetype for new articles, and includes instructions for editing and publishing a new `article` item, found at `root/archetypes/article.md` - Leave `draft:true` + (INTERNAL) This is a copy of the archetype for new articles, and includes instructions for editing and publishing a new `article` item, found at `root/archetypes/article.md` --- -Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content). -The Hugo terminal command for creating a new `article` is: -``` -hugo new article/article-short-title.md -``` +If creating a new entry via the terminal: +- The Hugo terminal command for creating a new `article` is: + ``` + hugo new article/article-short-title.md + ``` + This will create new file at `content/article/article-short-title.md`. The new file will be created according to the archetype for articles at `root/archetypes/article.md`. The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before committing or publishing new content. -This will create new file at `content/article/article-short-title.md`. The new file will be created according to the archetype for articles at `root/archetypes/article.md`. -The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before publishing new content. +If creating a new entry via the online preview page: +- the new entry will be empty. Please use the sample [YAML header below](#yaml) as starting point, and also copy to the new file the [instructions](#instructions) provided below. +# Sample YAML header {#yaml} -# Sample YAML header - ``` --- title: "Title sample ⚫ 📑" @@ -39,7 +38,7 @@ abstract: | --- ``` -# Instructions for article-file creator/editor +# Instructions for article-file creator/editor {#instructions} 0. [x] Put a checkmark to all items of this list that have been completed. This, by changing: > `1. [ ]` to `1. [x]` diff --git a/content/article/int-archetype-contributor.md b/content/article/int-archetype-contributor.md index 0507b04..46dccb2 100644 --- a/content/article/int-archetype-contributor.md +++ b/content/article/int-archetype-contributor.md @@ -3,28 +3,28 @@ title: "New Contributor Archetype 🧜" date: "2023-07-13T14:15:20+03:00" author: "anybody" contributors: ["constantinos-miltiadis.md"] -draft: true +draft: false keywords: - archetype - internal - guide abstract: | - This is a copy of the archetype for contributors (authors), and includes instructions for editing and publishing a new `contributor` item, found at `root/archetypes/contributor.md` - Leave `draft:true` + (INTERNAL) This is a copy of the archetype for contributors (authors), and includes instructions for editing and publishing a new `contributor` item, found at `root/archetypes/contributor.md` --- -Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content). -The Hugo terminal command for creating a new `contributor` is: -``` -hugo new contributor/name-surname.md -``` +If creating a new entry via the terminal: +- The Hugo terminal command for creating a new `contributor` is: + ``` + hugo new contributor/name-surname.md + ``` + This will create new file at `content/contributor/name-surname.md`. The new file will be created according to the archetype for articles at `root/archetypes/contributor.md`. The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before committing or publishing new content. -This will create new file at `content/contributor/name-surname.md`. The new file will be created according to the archetype for articles at `root/archetypes/contributor.md`. -The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before publishing new content. +If creating a new entry via the online preview page: +- the new entry will be empty. Please use the sample [YAML header below](#yaml) as starting point, and also copy to the new file the [instructions](#instructions) provided below. -# Sample YAML Header +# Sample YAML Header {#yaml} -If creating a new entry via the online preview page, the new entry will be empty. Please use the sample YAML file below as starting point, and also copy to the new file the instructions provided below. +If creating a new entry via the online preview page, the new entry will be created as an empty file. Please use the sample YAML file below as starting point, and also copy to the new file the instructions provided below. ``` --- @@ -40,7 +40,7 @@ draft: true **Name Surname** is .... contact: something at something dot edu -# Instructions for contributor-file creator/editor +# Instructions for contributor-file creator/editor {#instructions} - **Filename** should follow the convention:` name-surname.md` - File creator insert **your own name** in the `author` field. diff --git a/content/article/int-archetype-editor.md b/content/article/int-archetype-editor.md index 3f09eff..aaf0d56 100644 --- a/content/article/int-archetype-editor.md +++ b/content/article/int-archetype-editor.md @@ -3,27 +3,25 @@ title: "New Editor Archetype ♕" date: "2023-07-13T14:15:15+03:00" author: "anybody" contributors: ["constantinos-miltiadis.md"] -draft: true +draft: false keywords: - archetype - internal - guide abstract: | - This is a copy of the archetype for `editor` items and includes instructions for editing and publishing a new editor item, found at `root/archetypes/editor.md` - Leave `draft:true` + (INTERNAL) This is a copy of the archetype for `editor` items and includes instructions for editing and publishing a new editor item, found at `root/archetypes/editor.md` --- -Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content). -The Hugo terminal command for creating a new `editor` is: -``` -hugo new editor/name-surname.md -``` +If creating a new entry via the terminal: +- The Hugo terminal command for creating a new `editor` is: + ``` + hugo new editor/name-surname.md + ``` + This will create new file at `content/editor/name-surname.md`. The new file will be created according to the archetype for articles at `root/archetypes/editor.md`. The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before committing or publishing new content. -This will create new file at `content/editor/name-surname.md`. The new file will be created according to the archetype for articles at `root/archetypes/editor.md`. -The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before publishing new content. - -# Sample YAML Header -If creating a new entry via the online preview page, the new entry will be empty. Please use the sample YAML file below as starting point, and also copy to the new file the instructions provided below. +If creating a new entry via the online preview page: +- the new entry will be empty. Please use the sample [YAML header below](#yaml) as starting point, and also copy to the new file the [instructions](#instructions) provided below. +# Sample YAML Header {#yaml} ``` --- @@ -41,7 +39,7 @@ draft: true contact: something at something dot edu -# Instructions for editor-file creator/editor +# Instructions for editor-file creator/editor {#instructions} - **Filename** should follow the convention: `name-surname.md` - File creator insert **your own name** in the `author` field. diff --git a/content/article/int-archetype-issue.md b/content/article/int-archetype-issue.md index fabe595..ca602e8 100644 --- a/content/article/int-archetype-issue.md +++ b/content/article/int-archetype-issue.md @@ -3,26 +3,26 @@ title: "New Issue Archetype 📕" date: "2023-07-13T14:15:05+03:00" author: "anybody" contributors: ["constantinos-miltiadis.md"] -draft: true +draft: false keywords: - archetype - internal - guide abstract: | - This is a copy of the archetype for new issues, and includes instructions for editing and publishing a new `issue` item, found at `root/archetypes/issue.md` - Leave `draft:true` + (INTERNAL) This is a copy of the archetype for new issues, and includes instructions for editing and publishing a new `issue` item, found at `root/archetypes/issue.md` --- -Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content). -The Hugo terminal command for creating a new `issue` is: -``` -hugo new issue/issue-5.md -``` - -This will create new file at `content/issue/issue-5.md`. The new file will be created according to the archetype for articles at `root/archetypes/issue.md`. The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before publishing new content. - -# Sample YAML header -If creating a new entry via the online preview page, the new entry will be empty. Please use the sample YAML file below as starting point, and also copy to the new file the instructions provided below. +If creating a new entry via the terminal: +- The Hugo terminal command for creating a new `issue` is: + ``` + hugo new issue/issue-5.md + ``` + This will create new file at `content/issue/issue-5.md`. The new file will be created according to the archetype for articles at `root/archetypes/issue.md`. The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before committing or publishing new content. + +If creating a new entry via the online preview page: +- the new entry will be empty. Please use the sample [YAML header below](#yaml) as starting point, and also copy to the new file the [instructions](#instructions) provided below. +# Sample YAML header {#yaml} +If creating a new entry via the online preview page, the new entry will be created as an empty file. Please use the sample YAML file below as starting point, and also copy to the new file the instructions provided below. ``` --- @@ -38,7 +38,7 @@ abstract: | The text of your abstract. --- ``` -# Instructions for issue-file creator/editor +# Instructions for issue-file creator/editor {#instructions} 0. [x]  Put a checkmark to all items of this list that have been completed by changing: > `1. [ ]` to `1. [x]` diff --git a/content/article/int-archetype-print.md b/content/article/int-archetype-print.md index 7488afd..7a167f8 100644 --- a/content/article/int-archetype-print.md +++ b/content/article/int-archetype-print.md @@ -3,28 +3,26 @@ title: "New Print Archetype 🖶" date: "2023-07-13T16:03:24+03:00" author: "anybody" contributors: ["constantinos-miltiadis.md"] -draft: true +draft: false keywords: - archetype - internal - guide abstract: | - This is a copy of the archetype for creating new `print` items, including instructions for creating and properly editing `print` items, found at `root/archetypes/article.md` - Leave `draft:true` + (INTERNAL) This is a copy of the archetype for creating new `print` items, including instructions for creating and properly editing `print` items, found at `root/archetypes/article.md` --- -Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content). -The Hugo terminal command for creating a new `issue` is: -``` -hugo new print/p-issue-5.md -``` +If creating a new entry via the terminal: +- The Hugo terminal command for creating a new `print` item for an issue is: + ``` + hugo new print/p-issue-5.md + ``` + This will create new file at `content/print/p-issue-5.md`. The new file will be created according to the archetype for articles at `root/archetypes/print.md`. The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before committing or publishing new content. + +If creating a new entry via the online preview page: +- the new entry will be empty. Please use the sample [YAML header below](#yaml) as starting point, and also copy to the new file the [instructions](#instructions) provided below. +# Sample YAML header {#yaml} -This will create new file at `content/print/p-issue-5.md`. The new file will be created according to the archetype for articles at `root/archetypes/print.md`. -The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before publishing new content. - -# Sample YAML header - -If creating a new entry via the online preview page, the new entry will be empty. Please use the sample YAML file below as starting point, and also copy to the new file the instructions provided below. ``` --- @@ -33,9 +31,10 @@ date: "2023-07-13T16:03:24+03:00" author: "file-creator-put-your-name-here" draft: true print: "article/sample-article.md" +keywords: [print] --- ``` -# Instructions to file creator +# Instructions to file creator {#instructions} File naming 1. If this concerns an issue, say `issue-5.md`, name this file `p-issue-5.md`. If this concerns an article say `article-title.md`, name this file `p-article-title.md`