we/jgdr
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added issue including file creation instructions. Added emojis to archetypes to track drafts and files created by mistake !publish!

Browse source
This commit is contained in:
constantinos 2023-07-15 14:36:36 +03:00
parent 945f464719
commit c77c71044c
11 changed files with 255 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
archetypes/article.md
View file

@ -1,5 +1,5 @@
---
title: "{{ replace .Name "-" " " | title }}"
title: "{{ replace .Name "-" " " | title }} ⚫ 📑"
date: "{{.Date}}"
author: "file-creator-put-your-name-here"
contributors: ["jane-contributor.md"]

4
archetypes/contributor.md
View file

@ -1,5 +1,5 @@
---
title: "{{ replace .Name "-" " " | title }}"
title: "{{ replace .Name "-" " " | title }} ⚫ 🧜"
date: "{{.Date}}"
author: "file-creator-put-your-name-here"
affiliation: "Some affiliation if applicable"
@ -10,7 +10,7 @@ draft: true
contact: something at something dot edu
# Instructions for issue-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.

4
archetypes/editor.md
View file

@ -1,5 +1,5 @@
---
title: "{{ replace .Name "-" " " | title }}"
title: "{{ replace .Name "-" " " | title }} ⚫ ♕"
date: "{{.Date}}"
author: "file-creator-put-your-name-here"
affiliation: "Some affiliation if applicable"
@ -11,7 +11,7 @@ draft: true
contact: something at something dot edu
# Instructions for issue-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.

7
archetypes/issue.md
View file

@ -1,5 +1,5 @@
---
title: "{{ replace .Name "-" " " | title }}"
title: "{{ replace .Name "-" " " | title }} ⚫ 📕"
date: "{{.Date}}"
author: "file-creator-put-your-name-here"
draft: true
@ -33,13 +33,14 @@ abstract: |
7. [ ] Fill the **issue abstract** -- if applicable. Following precise formatting, 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**: go to `content/journal/index.md` and add the name of this file (not title) to the field `has_issues`. Note: articles included in this issue will not appear unless this is parented to the journal item. Example:
9. [ ] **Parent issue to journal**
- If, and only if this issue is ready to be published and `draft: False` you can parent go to `content/journal/jgdr.md` and add the name of this file (not title) to the field `has_issues`. Note: articles included in this issue will not appear unless this is parented to the journal item. Example:
> `has_issues: ["this-issues-file-name.md"]`
10. [ ] **Add issue-editorial text** below this section.
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. <!-- anthing inside these symbols will be hidden -->
14. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. <!-- anything inside these symbols will be hidden -->
15. [ ] Delete this section when all is in order.
16. Done!

2
archetypes/journal.md
View file

@ -1,5 +1,5 @@
---
title: "{{ replace .Name "-" " " | title }}"
title: "{{ replace .Name "-" " " | title }} ⚫ ☮"
date: "{{.Date}}"
author: "editor-put-your-name-here"
draft: true

2
archetypes/print.md
View file

@ -1,5 +1,5 @@
---
title: "{{ replace .Name "-" " " | title }}"
title: "{{ replace .Name "-" " " | title }} ⚫ ✉"
date: "{{.Date}}"
author: "editor-put-your-name-here"
draft: true

62
content/article/int-archetype-article.md Normal file
View file

@ -0,0 +1,62 @@
---
title: "New Article Archetype 📑"
date: "2023-07-13T14:15:10+03:00"
author: "file-creator-put-your-name-here"
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`
---
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.
# 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:
> `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"`
3. [ ] Set the `title` to the **title** of the article as in:
> `title: "An Answer to the Question: What is Game Design Research"`
4. [ ] Create **entries for article contributors** -- if they are not there -- and add their bio/info.
5. [ ] **Add the article's author(s)** in the `contributors` field as above (comma separated; inside quotation marks; including extension):
> `contributors: ["jane-contributor.md", "some-other.md"]`
6. [ ] Add **article keywords**. Follow exact formatting as above, otherwise the file/site will break.
```
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. <!-- anthing inside these symbols will be hidden -->
14. [ ] Delete this section when all is in order.
15. Done!
<!-- Editor's checklist temp
To do:
- [ ] Task 1
- [ ] Task 2
Issues:
1. Issue 1: Description
2. Issue 2: Description
-->

64
content/article/int-archetype-contributor.md Normal file
View file

@ -0,0 +1,64 @@
---
title: "New Contributor Archetype 🧜"
date: "2023-07-13T14:15:20+03:00"
author: "anybody"
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`
---
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.
---
**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:
- 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. <!-- anthing inside these symbols will be hidden -->
14. [ ] Delete this section when all is in order.
15. Done!
<!-- Editor's checklist temp
To do:
- [ ] Task 1
- [ ] Task 2
Issues:
1. Issue 1: Description
2. Issue 2: Description
-->

38
content/article/int-archetype-editor.md Normal file
View file

@ -0,0 +1,38 @@
---
title: "New Editor Archetype ♕"
date: "2023-07-13T14:15:15+03:00"
author: "anybody"
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`
---
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
```
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.
---
**Name Surname** is ....
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:
- 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.

64
content/article/int-archetype-issue.md Normal file
View file

@ -0,0 +1,64 @@
---
title: "New Issue Archetype 📕"
date: "2023-07-13T14:15:05+03:00"
author: "anybody"
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`
---
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`, and will contain the instruction steps below.
# 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:
> `author: "creators-name"`
3. [ ] Set the `title` to the **title of the issue**, as in:
> `title: "Issue 5: What is Game Design Research?"`
4. [ ] Create **entries for issue editors** – if they are not there – and add their bio/info.
5. Add **issue editors** as above (comma separated; inside quotation marks; including extension):
> `editors: ["jane-editor.md", "joe-editor.md"]`
6. [ ] Add **issue keywords** -- if applicable. Follow exact formatting as above, otherwise the site will break.
```
keywords:
- keyword one
- keyword two
```
7. [ ] Fill the **issue abstract** -- if applicable. Following precise formatting, 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**
- If, and only if this issue is ready to be published and `draft: False` you can parent go to `content/journal/jgdr.md` and add the name of this file (not title) to the field `has_issues`. Note: articles included in this issue will not appear unless this is parented to the journal item. Example:
> `has_issues: ["this-issues-file-name.md"]`
10. [ ] **Add issue-editorial text** below this section.
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. <!-- anything inside these symbols will be hidden -->
15. [ ] Delete this section when all is in order.
16. Done!
<!-- Editor's checklist temp
To do:
- [ ] Task 1
- [ ] Task 2
Issues:
1. Issue 1: Description
2. Issue 2: Description
-->

16
content/issue/int-archetypes.md Normal file
View file

@ -0,0 +1,16 @@
---
title: "Archetypes & content creation instructions 🦺 ⛏"
date: "2023-07-13T14:12:58+03:00"
author: "file-creator-put-your-name-here"
draft: true
has_articles: ["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`
---
Make sure to check the ![new file convention guide](article:int-conventions).