Skip to content

Commit 1a36c4f

Browse files
chore(repo): sync from inner source
Sync from github/github-well-architected-internal (main) Source Repository: github/github-well-architected-internal Source Branch: main Source SHA: b3c9ef8f94b4953f492545794b5e12ba18177243 Co-authored-by: well-architected-sync-bot[bot] <235114805+well-architected-sync-bot[bot]@users.noreply.github.com>
1 parent 34dc5ba commit 1a36c4f

1 file changed

Lines changed: 27 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -133,18 +133,13 @@ Once you're ready to start, fork the repository and begin authoring. We **strong
133133

134134
There are three options to create a new article:
135135

136-
##### 1. Copy/paste the template into a new file
137-
138-
Simply copy [`archetypes/default.md`] and paste it into:
139-
140-
```plaintext
141-
content/library/{PILLAR}/recommendations/{ARTICLE-NAME}.md
142-
```
143-
144-
##### 2. Use the command `hugo new content` to create a new file (recommended in Codespaces)
136+
##### Option 1. Use the command `hugo new content` to create a new file (recommended in Codespaces)
145137

146138
```shell
139+
# For recommendations:
147140
hugo new content library/{PILLAR}/recommendations/{ARTICLE-NAME}.md
141+
# For scenarios:
142+
hugo new content library/scenarios/{ARTICLE-NAME}.md
148143
```
149144

150145
For example,
@@ -156,7 +151,7 @@ hugo new content library/productivity/recommendations/my-article.md
156151
> [!IMPORTANT]
157152
> When you use this method, you do not need to put `content/` in the command since Hugo considers it the root.
158153
159-
##### 3. Use a page bundle to create a new article with associated files like images
154+
##### Option 2. Use a page bundle to create a new article with associated files like images
160155

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

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

164+
##### Option 3. Copy/paste the template into a new file
165+
166+
Simply copy [`archetypes/default.md`] and paste it into:
167+
168+
For **recommendation** articles:
169+
170+
```plaintext
171+
content/library/{PILLAR}/recommendations/{ARTICLE-NAME}.md
172+
```
173+
174+
For **scenario** articles:
175+
176+
```plaintext
177+
content/library/scenarios/{ARTICLE-NAME}.md
178+
```
179+
169180
##### Writing Style:
170181

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

186197
# Add author details
187198
params:
188-
author:
189-
name: Mona
190-
handle: octocat
199+
authors:
200+
[
201+
{ name: 'Mona', handle: 'octocat' },
202+
]
191203

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

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

213+
- Set `publishDate` to the date the article is first merged to `main`. Do not change it on future revisions.
214+
201215
- 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!**
202216

203217
---

0 commit comments

Comments
 (0)