Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 27 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,18 +133,13 @@ Once you're ready to start, fork the repository and begin authoring. We **strong

There are three options to create a new article:

##### 1. Copy/paste the template into a new file

Simply copy [`archetypes/default.md`] and paste it into:

```plaintext
content/library/{PILLAR}/recommendations/{ARTICLE-NAME}.md
```

##### 2. Use the command `hugo new content` to create a new file (recommended in Codespaces)
##### Option 1. Use the command `hugo new content` to create a new file (recommended in Codespaces)

```shell
# For recommendations:
hugo new content library/{PILLAR}/recommendations/{ARTICLE-NAME}.md
# For scenarios:
hugo new content library/scenarios/{ARTICLE-NAME}.md
```

For example,
Expand All @@ -156,7 +151,7 @@ hugo new content library/productivity/recommendations/my-article.md
> [!IMPORTANT]
> When you use this method, you do not need to put `content/` in the command since Hugo considers it the root.

##### 3. Use a page bundle to create a new article with associated files like images
##### Option 2. Use a page bundle to create a new article with associated files like images

Add a folder (instead of one markdown file) at that location and bundle the files together. The format is:

Expand All @@ -166,6 +161,22 @@ content/library/{PILLAR}/recommendations/{ARTICLE-NAME}/image1.png
content/library/{PILLAR}/recommendations/{ARTICLE-NAME}/image2.png
```

##### Option 3. Copy/paste the template into a new file

Simply copy [`archetypes/default.md`] and paste it into:

For **recommendation** articles:

```plaintext
content/library/{PILLAR}/recommendations/{ARTICLE-NAME}.md
```

For **scenario** articles:

```plaintext
content/library/scenarios/{ARTICLE-NAME}.md
```

##### Writing Style:

- Always use sentence case
Expand All @@ -185,9 +196,10 @@ publishDate: 2024-12-05 # Date the article is published

# Add author details
params:
author:
name: Mona
handle: octocat
authors:
[
{ name: 'Mona', handle: 'octocat' },
]

# Classifications of the framework to drive key concepts, design principles, and architectural best practices
pillars:
Expand All @@ -198,6 +210,8 @@ pillars:

- When you are done with your article, set `draft: false` when you are ready to publish.

- Set `publishDate` to the date the article is first merged to `main`. Do not change it on future revisions.

- All recommended values for all of these fields are described in [Taxonomies]. **Insert all that apply to your article. This is how your article will be discoverable!**

---
Expand Down