jgdr/content/article/int-archetype-issue.md

64 lines
3.3 KiB
Markdown
Raw Normal View History

---
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, 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).
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.
# 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. 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**
- 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.
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
-->