update default article template, device anon title, and readme for article reviews
This commit is contained in:
parent
230cc8fe23
commit
7f98d082c1
3 changed files with 32 additions and 2 deletions
24
README.md
24
README.md
|
@ -1,5 +1,7 @@
|
|||
# web.myco.systems
|
||||
|
||||
### Start developing with the site
|
||||
|
||||
MycoSystems client site
|
||||
|
||||
```
|
||||
|
@ -15,11 +17,31 @@ git switch rework
|
|||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
Optionally, if you are planning to open a PR please use hugo prettier
|
||||
Optionally we recommend installing prettier, the prettierrc file is already preconfigured to use the go template plugin.
|
||||
|
||||
```
|
||||
npm install --save-dev prettier prettier-plugin-go-template
|
||||
```
|
||||
|
||||
### Writing articles
|
||||
|
||||
- [ ] Grammar checked
|
||||
- [ ] Spelling checked
|
||||
- [ ] Title fits the article
|
||||
- [ ] folder name is short and fits the title
|
||||
- [ ] Lead and description are populated and fit the article
|
||||
|
||||
#### New Articles
|
||||
When starting a new article or page use the command `hugo new content`
|
||||
This will create a new folder and markdown file with frontmatter for a title and description, under the frontmatter is a lead. The lead is to substitue the description as the description is only used for opengraph, the lead will display right under the title when a user is reading that page or article.
|
||||
```
|
||||
hugo new content content/new-page/index.md
|
||||
```
|
||||
|
||||
#### Editing/Reviewing Articles
|
||||
When reviewing, an article should have a fitting title, the folder should match the name of the article (The folder decides the name of the articles's slug), and there should be a description and lead that are fitting to the article.
|
||||
|
||||
Other than that make sure to check off the basics, grammar, spelling, and split up run-on sentences.
|
||||
|
||||
# License:
|
||||
[MIT](https://git.myco.systems/mycosystems/web.myco.systems/src/branch/main/LICENSE), thank you to the people over at [Blowfish](https://blowfish.page)
|
8
archetypes/default.md
Normal file
8
archetypes/default.md
Normal file
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: "{{ replace .Name "-" " " | title }}"
|
||||
draft: true
|
||||
description: ""
|
||||
---
|
||||
{{< lead >}}
|
||||
|
||||
{{< /lead >}}
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: "Device Anonymization"
|
||||
title: "Fleet Device Hardening"
|
||||
draft: false
|
||||
description: "Learn how you could implement anonymized hardware."
|
||||
---
|
||||
|
|
Loading…
Add table
Reference in a new issue