jgdr/content/article/int-conventions.md

83 lines
1.8 KiB
Markdown
Raw Normal View History

---
title: "Conventions (INTERNAL)"
date: "2023-06-29T23:38:56+03:00"
author: "editor-put-your-name-here"
contributors:
draft: true
keywords:
- internal
abstract: |
Conventions for filenames, etc.
---
# Dates
> DD.MM.YYYY
as in 13.05.1998. In general, day first.
# File naming conventions
- All **lowercase**
- Use **dash as separator**
- No spaces
- No underscores
| Type | Filename convention | Creation command |
|-|-|-|
| contributor | name-surname.md | `hugo new contributor/name-surname.md`|
| editor | name-surname.md | `hugo new editor/name-surname.md` |
| issue | issue-x.md | `hugo new issue/issue-x.md` |
| article | article-short-title.md | `hugo new article/article-short-title.md` |
| print (issue)\* | p-issue-x.md | `hugo new print/p-issue-x.md` |
| print (article)\*\* | p-article-short-title.md | `hugo new print/p-article-short-title.md` |
\* where x is issue number
\*\* creating a new print file can break the site, until
# Files intended for *Internal* use
Files purposed to be for internal use, and are *not public facing*:
- start with `int-` , like this file `int-conventions.md`
Their header file:
- features the keyword `internal`
- the draft flag is set to true, as in `draft: true`
# Images and attachments
> static/issue-x/author/image.png
<!--
# File naming conventions
Filenames are all lowercase. No spaces, no underscores, only dashes.
# Contributors, Editors
> name-surname.md
as in `pippin-bar.md`
To create a new contributor do:
> hugo new contributor/name-surname.md
## Issues
> issue-x.md
where x is the issue number:
- issue-5.md
To create a new issue do:
> hugo new issue/issue-x.md
## Print files
Print files correspond to issues or articles.
> hugo new print/p-issue-5.md
or
> hugo new print/p-article-name.md
-->