Where to Add the Article

Go to the place where you want to add the article, then identify:

  1. What is the Baord: Plan
  2. What is the Book: Flow
  3. What is the Article Group: Writing Articles
  4. Where you want to place the new Article: Under “Style Guide”
  5. What is the new Article’s name: Adding Articles
  6. Create Path: V² > Plan > Flow > Writing Articles > Adding Articles

Creating Menu Entry

Get ready to edit book-bar.yaml

  1. Go to V² > V-Squared.github.io > _data
    • Note: Make sure it is in the Master Branch
  2. Pick the Board in which you want to add the Article
    • Note: In this example we choose Plan
  3. Open “book-bar.yml”
  4. Click the Edit Button
  5. Add the Article into the tree structure of this yml document
    • Note: The syntax should be obvious to you after reading this file. If not, please read -> Wikipedia > YAML
  6. Example code change

Find where to edit

  1. Remember Path: V² > Plan > Flow > Writing Articles > Adding Articles
  2. Remember where to place: Under “Style Guide”
  3. Find the place to add the Article

Add Article to book-bar.yaml

Duplicate Entry

Duplicate an entry of same type as we need.

Edit Entry

Edit the duplicate to match the article we want to create.

Commit your Change

  1. Enter Commit Message
  2. Press Button Commit Changes

Create the Article-Issue

Create new Issue

  1. Go to Issues of V-Squared/V-Squared.github.io
  2. Click button: “New issue”

Add Content to Article Issue

  1. Paste the Path into the Title field
  2. Paste Issue Task Template into the Leave a comment field
  3. Update Article-Path and Article URL in Reference section of Issue Task Template
    • Note: You will use this link when you want to open the matching article to this issue.
  4. Add: Labels, Milestones, Assignees
    • Note: Labels that start with “m.” are mandatory, instead “o.” is optional.
  5. Tick completed tasks
  6. Press: *Submit new issue”

Issue Task Template

# Generic Tasks

- [x] Create Issue
- [ ] Add Link to Article in Reference of this Issue
- [ ] Classify Labels, Milestone & Assignee
- [ ] Create Article
- [ ] Create Title / Subtitle / Abstract
- [ ] Enter Issue No in Article
- [ ] Write Article
- [ ] Add cross references
- [ ] Trigger review
- [ ] Include review feedback


# Reference
- [Article > Path > ???](Article/URL/???/)

Note Issue Number

In this case the Issue Number is 185. You need it later to link the Issue to the Article.

Create Article File

Create File

  1. Remember Path: V² > Plan > Flow > Writing Articles > Adding Articles
  2. Go to corresponding folder in <>Code: V-Squared.github.io/plan/flow/writing/
  3. Click “Create new File* button

Add Content

  1. Enter file name: “adding-articles.md”
    • Note: If this does not match your entry in book-bar.yml you will get a 404 Error when browsing to this page in the Article-Bar.
    • Note: Remember to add the extension “.md”. This indicates that the file content is of Markdown type.
  2. Copy Paste the YML Template (see below)
  3. Fill out the YML Template
    • Note 1: You can use markdown formatting in subtitle and abstract if you use the greater sign: “>” in combination with new line and tab indent. See the screen snapshot.
    • Note 2: Except for the above you are not allowed to use new line within values.
  4. Enter Commit Message
  5. Press Button: “Commit new file”

YML Template

---
layout: page
title: 
subtitle: 
abstract: 
issueNo: 
readiness:
   - is-active
---

Check the Added Article

  1. Reload the Article Page
  2. The added article should show up in Article Navigation Bar
  3. Click the newly addded article. It should load properly

Add Issue Number in Article

If the Issue is not yet linked to the Article yet, you can link it like so:

Hovering V²-Flow-Button

Hovering shows you the Tooltip to the V²-Flow-Button with link to its help.

Clicking V²-Flow-Button

  1. On click the Floating Action Menu of the V²-Flow-Button is shown. Select: “Edit Article”.
  2. Click the “Edit Article” Button
  3. The GitHub text editor opens in a new tab with the mathching markdown file to the article.

Linking the Issue

  1. Enter the Issue Number to the property: “issueNo:** Note 1: See above on how to find the value of the issue number Note 2: Make sure to have a space between the colon and the number

Tip: Create Article Group

Step 1: Create the Menu Entries

- menu: Flow
  url: /flow/
  desc: >
    Workflows on contributing to V² in ready to use quality.
  subitems:
    - menu: Writing Articles
      group: 
        - menu: Intro Writing Articles
          url: /flow/writing/intro/
        - menu: How-To Task-Templates
          url: /flow/writing/how-to/
        - menu: Style Guide
          url: / flow/writing/style-guide/

Step 2: Create Issues & Note Issue Number

- menu: Flow
  url: /flow/
  desc: >
    Workflows on contributing to V² in ready to use quality.
  subitems:
    - menu: Writing Articles
      group: 
        - menu: Intro Writing Articles   #176
          url: /flow/writing/intro/
        - menu: How-To Task-Templates #177
          url: /flow/writing/how-to/
        - menu: Style Guide #178
          url: / flow/writing/style-guide/

Step 3: Create Article

The trick is that now you already have the Issue Numbers and can enter them into the yml file. This saves you the step to later link the Article to the Issue.