From 9c5972bb17a1badbd771f1a6dda2f936c976dabc Mon Sep 17 00:00:00 2001 From: constantinos Date: Wed, 2 Aug 2023 16:45:14 +0300 Subject: [PATCH] finalized edits of archetypes and archetype issue --- archetypes/article.md | 8 ++-- archetypes/contributor.md | 15 +++---- archetypes/editor.md | 14 +++--- archetypes/issue.md | 8 ++-- archetypes/journal.md | 4 +- archetypes/print.md | 25 ++++++----- content/article/int-archetype-article.md | 17 ++++---- content/article/int-archetype-contributor.md | 46 +++++--------------- content/article/int-archetype-editor.md | 19 ++++---- content/article/int-archetype-issue.md | 14 +++--- content/article/int-archetype-print.md | 30 +++++++++---- content/issue/int-archetypes.md | 28 ++++++------ 12 files changed, 110 insertions(+), 118 deletions(-) diff --git a/archetypes/article.md b/archetypes/article.md index 36369e7..14b4106 100644 --- a/archetypes/article.md +++ b/archetypes/article.md @@ -9,13 +9,11 @@ keywords: abstract: | The text of your abstract. (Below is an instruction checklist for article-file creators/editors) --- - - # Instructions for article-file creator/editor: 0. [x] Put a checkmark to all items of this list that have been completed. This, by changing: > `1. [ ]` to `1. [x]` -1. **File naming**: Follow ![conventions for article file-naming](article:int-conventions). Example: +1. [ ] **File naming**: Follow ![conventions for article file-naming](article:int-conventions). Example: > `i5-short-title.md` (where i5 is issue 5) 2. [ ] (File editor) **Insert your name** in the `author` field inside "quotation marks" as in: > `author: "creators-name"` @@ -30,14 +28,14 @@ abstract: | - keyword one - keyword two ``` -7. [ ]  Fill the **abstract**. Following precise formatting, otherwise the site will break. +7. [ ]  Fill the **abstract** following exact formatting like above, otherwise the site will break. 8. [ ] **Parent article to issue**: go to `content/issue/some-issue.md` and add the name of this file (not title) to the field `has_articles`. Example: > `has_articles: ["this-articles-file-name.md"]` 9. [ ] **Add article content** text below this section. 10. [ ] **Log potential problems** with this article by making another check-list below (commented sample lists provided below). 11. [ ] **Git commit and push** if/when applicable; providing a commit message describing your changes. 12. [ ] **Set the draft flag** accordingly. **False will make this public**: only do that when ready to publish. Leave `draft: true` when in-progress. -13. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. +13. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. 14. [ ] Delete this section when all is in order. 15. Done! diff --git a/archetypes/contributor.md b/archetypes/contributor.md index 3ab657a..9424ed5 100644 --- a/archetypes/contributor.md +++ b/archetypes/contributor.md @@ -9,15 +9,14 @@ draft: true **{{ replace .Name "-" " " | title }}** is .... contact: something at something dot edu +# Instructions for contributor-file creator/editor -# Instructions for contributor-file creator/editor: - -- Filename should follow the convention: name-surname.md -- Insert your own name at the 'author' field. -- Set affiliation if applicable. -- Fill in content: +- **Filename** should follow the convention:` name-surname.md` +- File creator insert **your own name** in the `author` field. +- Set **affiliation** if applicable (`affiliation: "Some University"`) +- Fill in **content**: - bio - contact email - Delete this section. -- Set draft flag (note that `draft: false` will make this entry public). -- Git commit and push your changes if/when applicable, providing a commit message describing your changes. +- Set **draft flag** (note that `draft: false` will make this entry public). +- Git **commit and push your changes if/when applicable**, providing a commit message describing your changes. \ No newline at end of file diff --git a/archetypes/editor.md b/archetypes/editor.md index b9571a6..480e634 100644 --- a/archetypes/editor.md +++ b/archetypes/editor.md @@ -11,14 +11,14 @@ draft: true contact: something at something dot edu -# Instructions for editor-file creator/editor: +# Instructions for editor-file creator/editor -- Filename should follow the convention: name-surname.md -- Insert your own name at the 'author' field. -- Set affiliation if applicable. -- Fill in content: +- **Filename** should follow the convention: `name-surname.md` +- File creator insert **your own name** in the `author` field. +- Set **affiliation** if applicable (`affiliation: "Some University"`) +- Fill in **content**: - bio - contact email - Delete this section. -- Set draft flag (note that `draft: false` will make this entry public). -- Git commit and push your changes if/when applicable, providing a commit message describing your changes. \ No newline at end of file +- Set **draft flag** (note that `draft: false` will make this entry public). +- Git **commit and push your changes if/when applicable**, providing a commit message describing your changes. \ No newline at end of file diff --git a/archetypes/issue.md b/archetypes/issue.md index 41e6bb9..c66038f 100644 --- a/archetypes/issue.md +++ b/archetypes/issue.md @@ -12,12 +12,11 @@ abstract: | --- # Instructions for issue-file creator/editor: - 0. [x]  Put a checkmark to all items of this list that have been completed by changing: > `1. [ ]` to `1. [x]` 1. [ ] **File naming**: Follow ![conventions for issue file-naming](article:int-conventions). Example: > `issue-5.md` -2. (File editor) **Insert your name** in the `author` field inside "quotation marks" as in: +2. [ ] (File editor) **Insert your name** in the `author` field inside "quotation marks" as in: > `author: "creators-name"` 3. [ ] Set the `title` to the **title of the issue**, as in: > `title: "Issue 5: What is Game Design Research?"` @@ -30,7 +29,7 @@ abstract: | - keyword one - keyword two ``` -7. [ ] Fill the **issue abstract** -- if applicable. Following precise formatting, otherwise the site will break. +7. [ ] Fill the **issue abstract** -- if applicable. Follow exact formatting as above, otherwise the site will break. 8. [ ] **Add the articles included in the issue** as above (comma separated; inside quotation marks; including extension): > `has_articles: ["article-test.md", "article-2.md", "article-3.md"]` 9. [ ] **Parent issue to journal** @@ -40,11 +39,10 @@ abstract: | 11. [ ] **Log potential problems or pending tasks** with this issue by making another check-list below (commented sample lists provided below). 12. [ ] **Git commit and push if/when applicable**, providing a commit message describing your changes. 13. [ ] **Set the draft flag** accordingly. *False will make this public*: only do that when ready to publish, and when there is already a 'print' file for the issue. Leave `draft: true` when in-progress. -14. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. +14. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. 15. [ ] Delete this section when all is in order. 16. Done! - + +*Note: Items that are not public/published (`draft: true`), cannot have a public/published print.* +*Note: Print items should not have any content under the YAML header. +--> \ No newline at end of file diff --git a/content/article/int-archetype-article.md b/content/article/int-archetype-article.md index e39feca..48202c7 100644 --- a/content/article/int-archetype-article.md +++ b/content/article/int-archetype-article.md @@ -1,31 +1,32 @@ --- title: "New Article Archetype 📑" date: "2023-07-13T14:15:10+03:00" -author: "file-creator-put-your-name-here" +author: "anybody" +contributors: ["constantinos-miltiadis.md"] draft: true 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 -- copied from `root/archetypes/article.md` + 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` --- - 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 ``` -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`, and will contain the instruction steps below. - +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. # Instructions for article-file creator/editor 0. [x] Put a checkmark to all items of this list that have been completed. This, by changing: > `1. [ ]` to `1. [x]` -1. **File naming**: Follow ![conventions for article file-naming](article:int-conventions). Example: +1. [ ] **File naming**: Follow ![conventions for article file-naming](article:int-conventions). Example: > `i5-short-title.md` (where i5 is issue 5) 2. [ ] (File editor) **Insert your name** in the `author` field inside "quotation marks" as in: > `author: "creators-name"` @@ -40,14 +41,14 @@ This will create new file at `content/article/article-short-title.md`. The new - keyword one - keyword two ``` -7. [ ]  Fill the **abstract**. Following precise formatting, otherwise the site will break. +7. [ ]  Fill the **abstract** following exact formatting like above, otherwise the site will break. 8. [ ] **Parent article to issue**: go to `content/issue/some-issue.md` and add the name of this file (not title) to the field `has_articles`. Example: > `has_articles: ["this-articles-file-name.md"]` 9. [ ] **Add article content** text below this section. 10. [ ] **Log potential problems** with this article by making another check-list below (commented sample lists provided below). 11. [ ] **Git commit and push** if/when applicable; providing a commit message describing your changes. 12. [ ] **Set the draft flag** accordingly. **False will make this public**: only do that when ready to publish. Leave `draft: true` when in-progress. -13. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. +13. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. 14. [ ] Delete this section when all is in order. 15. Done! diff --git a/content/article/int-archetype-contributor.md b/content/article/int-archetype-contributor.md index f597814..3259cf6 100644 --- a/content/article/int-archetype-contributor.md +++ b/content/article/int-archetype-contributor.md @@ -2,63 +2,39 @@ title: "New Contributor Archetype 🧜" date: "2023-07-13T14:15:20+03:00" author: "anybody" +contributors: ["constantinos-miltiadis.md"] draft: true 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 -- copied from `root/archetypes/contributor.md` + 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` --- - 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 ``` -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`, and will contain the content and instruction steps below. +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. --- **Name Surname** is .... contact: something at something dot edu - # Instructions for contributor-file creator/editor -- Filename should follow the convention: name-surname.md -- Insert your own name at the 'author' field. -- Set affiliation if applicable. -- Fill in content: +- **Filename** should follow the convention:` name-surname.md` +- File creator insert **your own name** in the `author` field. +- Set **affiliation** if applicable (`affiliation: "Some University"`) +- Fill in **content**: - bio - contact email - Delete this section. -- Set draft flag (note that `draft: false` will make this entry public). -- Git commit and push your changes if/when applicable, providing a commit message describing your changes. - - keywords: - - keyword one - - keyword two - ``` -7. [ ]  Fill the **abstract**. Following precise formatting, otherwise the site will break. -8. [ ] **Parent article to issue**: go to `content/issue/some-issue.md` and add the name of this file (not title) to the field `has_articles`. Example: - > `has_articles: ["this-articles-file-name.md"]` -9. [ ] **Add article content** text below this section. -10. [ ] **Log potential problems** with this article by making another check-list below (commented sample lists provided below). -11. [ ] **Git commit and push** if/when applicable; providing a commit message describing your changes. -12. [ ] **Set the draft flag** accordingly. **False will make this public**: only do that when ready to publish. Leave `draft: true` when in-progress. -13. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. -14. [ ] Delete this section when all is in order. -15. Done! - - \ No newline at end of file +- Set **draft flag** (note that `draft: false` will make this entry public). +- Git **commit and push your changes if/when applicable**, providing a commit message describing your changes. \ No newline at end of file diff --git a/content/article/int-archetype-editor.md b/content/article/int-archetype-editor.md index 16fcc99..f20733b 100644 --- a/content/article/int-archetype-editor.md +++ b/content/article/int-archetype-editor.md @@ -2,13 +2,15 @@ title: "New Editor Archetype ♕" date: "2023-07-13T14:15:15+03:00" author: "anybody" +contributors: ["constantinos-miltiadis.md"] draft: true 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 -- copied from `root/archetypes/editor.md` + 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` --- Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content). @@ -17,7 +19,8 @@ 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`, and will contain the content and instruction steps below. +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. --- @@ -27,12 +30,12 @@ contact: something at something dot edu # Instructions for editor-file creator/editor -- Filename should follow the convention: name-surname.md -- Insert your own name at the 'author' field. -- Set affiliation if applicable. -- Fill in content: +- **Filename** should follow the convention: `name-surname.md` +- File creator insert **your own name** in the `author` field. +- Set **affiliation** if applicable (`affiliation: "Some University"`) +- Fill in **content**: - bio - contact email - Delete this section. -- Set draft flag (note that `draft: false` will make this entry public). -- Git commit and push your changes if/when applicable, providing a commit message describing your changes. \ No newline at end of file +- Set **draft flag** (note that `draft: false` will make this entry public). +- Git **commit and push your changes if/when applicable**, providing a commit message describing your changes. \ No newline at end of file diff --git a/content/article/int-archetype-issue.md b/content/article/int-archetype-issue.md index 507194e..2efaeb5 100644 --- a/content/article/int-archetype-issue.md +++ b/content/article/int-archetype-issue.md @@ -2,13 +2,15 @@ title: "New Issue Archetype 📕" date: "2023-07-13T14:15:05+03:00" author: "anybody" +contributors: ["constantinos-miltiadis.md"] draft: true 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 -- copied from `root/archetypes/issue.md` + 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` --- Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content). @@ -17,15 +19,14 @@ 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`, and will contain the instruction steps below. - +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. # Instructions for issue-file creator/editor 0. [x]  Put a checkmark to all items of this list that have been completed by changing: > `1. [ ]` to `1. [x]` 1. [ ] **File naming**: Follow ![conventions for issue file-naming](article:int-conventions). Example: > `issue-5.md` -2. (File editor) **Insert your name** in the `author` field inside "quotation marks" as in: +2. [ ] (File editor) **Insert your name** in the `author` field inside "quotation marks" as in: > `author: "creators-name"` 3. [ ] Set the `title` to the **title of the issue**, as in: > `title: "Issue 5: What is Game Design Research?"` @@ -38,7 +39,7 @@ This will create new file at `content/issue/issue-5.md`. The new file will be c - keyword one - keyword two ``` -7. [ ] Fill the **issue abstract** -- if applicable. Following precise formatting, otherwise the site will break. +7. [ ] Fill the **issue abstract** -- if applicable. Follow exact formatting as above, otherwise the site will break. 8. [ ] **Add the articles included in the issue** as above (comma separated; inside quotation marks; including extension): > `has_articles: ["article-test.md", "article-2.md", "article-3.md"]` 9. [ ] **Parent issue to journal** @@ -48,11 +49,10 @@ This will create new file at `content/issue/issue-5.md`. The new file will be c 11. [ ] **Log potential problems or pending tasks** with this issue by making another check-list below (commented sample lists provided below). 12. [ ] **Git commit and push if/when applicable**, providing a commit message describing your changes. 13. [ ] **Set the draft flag** accordingly. *False will make this public*: only do that when ready to publish, and when there is already a 'print' file for the issue. Leave `draft: true` when in-progress. -14. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. +14. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. 15. [ ] Delete this section when all is in order. 16. Done! -