Epic > 015 > Parent: Compile Manual > Writing Articles

[VillageHubertChen]

• [x] Create Workflow Compiling Know How
• [x] Find the spot where to publish → #82
• [x] Create Linked List of Articles
• [ ] Keep writing know how in here, until we are ready to publish
• [ ] Move this Article Series to its final resting place:
  • V²►Plan►Flow►Articles►Task-Template
• [ ] Rework existing tasks to update links to new location of documentation

  Workflow Compiling Know How

• Each article is filed in a separate comment, this makes editing manageable
• This comment contains a linked List of Articles, this keeps an overview
• Once we a) create V²Spreading and b) have completed compiling we move these comments to Articles in the final resting Place → V²►Spreading►Know How►Writing Articles → #82

  Shortcut to Learning

  Remember basic rules and not details

  List of Basic Rules

  Manually now, Automated Later

  List of Articles on Writing Articles

• Create Article Issue
• Insert DIY Article Issue Template
• Set Title, Subtitle & Abstract
• Linking Issues to Articles
• Link Article to Issue in Reference
• Styling Tables
• Creating a Table of Contents
• Cleaning Up Kramdown Code
• Setting Readiness Bar
• Text Includes for Redundant Text
• Using Referenced URL
• Restructure Article
• Add Permalinks
• Add Visual Placeholders
• Article Review

  Reference

• → https://github.com/V-Squared/V-Squared.github.io/issues/117

[VillageHubertChen]

Linking Issues to Articles

[VillageHubertChen]

Styling Tables

[VillageHubertChen]

Creating a Table of Contents

• [ ] LC: Turn on Automatic Table of Contents in the Article → V²►DIY►CPU
• [ ] LC: Document in here all steps on how to do just that

Reference

• → kramdown►Automatic “Table of Contents” Generation
• → stackoverflow►Customize ToC in Jekyll
• → Automatic Table of Contents Generation #130

[VillageHubertChen]

Cleaning Up Kramdown Code

• [x] Add lines between headings
• [x] Add lines in front of code blocks, such as tables
• [ ] Change URL in tables to use Referenced Links

Difference between Kramdown and GitHub Markdown

Reference

Rules to make both Markdown Dialects Happy

[VillageHubertChen]

Understanding Readiness Bar

At this point (and for

Setting Readiness Bar

Location

Purpose

Logic

Tooltips

States of Readiness Bar

Scheduled

Create-Active

Create-Complete

Develop-Active

Develop-Complete

Beta-Active

if you will actively pull in editor's comments

Beta-Passive

Keep the Article published in this state for some time to see any comments coming in.

Make-Active

Note: Items which requite ongoing activity in production will be set to Make-Active. Example would be hardware products, such as ViCase. If you were to set the ViCase product page to Make-Complete you would indicate that it has reached its end of life.

Make-Complete

Note: Items which only require a one time activity to put it into the Make state forever will be set to Make-Active. Example would be publication of an article on our site.

[VillageHubertChen]

Text Includes for Redundant Text

[VillageHubertChen]

Using Referenced URL

[VillageHubertChen]

Create Article Issue

Workflow

1. Get Mating Issue Name
   • Open Article
   • Press Clipboard 1 Icon to copy the Article Path
2. Create Issue
   • Open → V²►V-Squared.github.io►Issues
   • Create New Issue
   • Paste Article Path in Issue Title
   • Paste Issue Template in "Leave a comment"
3. Classify Issue
   • Set Labels
   • Set Milestone
   • Set Assignee
4. Submit new issue

Quality Check

• Article Path and Issue Title Match
• All Labels, Milestone, Assignee set

How does this Fit into the Big Picture

Assist Writer

Assist Editor

Assist Reader

Assist Searching

[VillageHubertChen]

Link Article to Issue in Reference

[VillageHubertChen]

Restructure Article

[VillageHubertChen]

Add Permalinks

[VillageHubertChen]

Add Visual Placeholders

• [ ] Visual Placeholders
  • [ ] Add text placeholder for graphics using Code Block
  • [ ] or find suitable placeholder graphics on the internet and edit to size: 853 x 480 px

[VillageHubertChen]

Article Review

• [ ] Trigger TC for Develop Review
• [ ] TC: Develop Review
• [ ] BC: Include Feedback Develop Review
• [ ] Set Readiness to Active Beta

Preflight Checklist

[VillageHubertChen]

Set Title, Subtitle & Abstract

[VillageHubertChen]

Insert DIY Article Issue Template