From 7f98d082c17621a397bd81d35a9842f3e45c619f Mon Sep 17 00:00:00 2001 From: brooke Date: Sun, 28 Apr 2024 19:23:10 -0400 Subject: [PATCH] update default article template, device anon title, and readme for article reviews --- README.md | 24 +++++++++++++++++++++++- archetypes/default.md | 8 ++++++++ content/services/device-anon/index.md | 2 +- 3 files changed, 32 insertions(+), 2 deletions(-) create mode 100644 archetypes/default.md diff --git a/README.md b/README.md index 51a6e3c..79184a1 100644 --- a/README.md +++ b/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) \ No newline at end of file diff --git a/archetypes/default.md b/archetypes/default.md new file mode 100644 index 0000000..bb828fe --- /dev/null +++ b/archetypes/default.md @@ -0,0 +1,8 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +draft: true +description: "" +--- +{{< lead >}} + +{{< /lead >}} \ No newline at end of file diff --git a/content/services/device-anon/index.md b/content/services/device-anon/index.md index 1e30483..d743afa 100644 --- a/content/services/device-anon/index.md +++ b/content/services/device-anon/index.md @@ -1,5 +1,5 @@ --- -title: "Device Anonymization" +title: "Fleet Device Hardening" draft: false description: "Learn how you could implement anonymized hardware." ---