From a57cd27974980596cc0e3509d588ee9dd1e693e9 Mon Sep 17 00:00:00 2001 From: "well-architected-sync-bot[bot]" <235114805+well-architected-sync-bot[bot]@users.noreply.github.com> Date: Mon, 18 May 2026 13:25:06 +0000 Subject: [PATCH] Sync from github/github-well-architected-internal (main) Source Repository: github/github-well-architected-internal Source Branch: main Source SHA: b3c9ef8f94b4953f492545794b5e12ba18177243 --- CONTRIBUTING.md | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a65386f..f6352a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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, @@ -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: @@ -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 @@ -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: @@ -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!** ---