# Outline
一、前言
二、文章結構
三、範例專案與程式碼
四、建議閱讀順序

# TL;DR
此篇文章是本系列文的導讀，會介紹文章的結構與常出現的資訊樣板；另外還有範例專案的使用方式；最後則是建議的閱讀順序，這部分會一直更新到本系列文結束為止。

在雙十連假前，此系列文每天的發文時都會以最簡陳述為主，以求在繁忙的日常中，至少能先維持挑戰鐵人賽的進度，並且逐漸拓展思路與系列結構。預期會在國慶連假將本篇文章論述完整。

一、前言

總算遇到一個有空的週末，儘管是前一天是補班，放假的只有一天，在這 30 天的挑戰中，仍是彌足珍貴。今天主要的進度是重整這 19 天來的產出，並且為各文章建立範例程式碼與專案。既然本篇稱之為 README，就讓我們用這篇聊聊這系列文的架構以及如何搭配範例專案與文章內的程式碼服用吧！

文章架構

2-1 綱要與簡述

本系列文的每篇文章最前面都會有一個程式碼區塊，裡面會放置本篇文章綱要（Outline）以及簡述（TL;DR），讓讀者一進到這篇文章就可以暸解本篇文章是否對其有用。

而在綱要中，以漢字有序列表的項目就是該篇文章的正文，若是羅馬字母有序列表的項目，就代表是附錄。附錄中多是和該篇文章的補述、參考資料、期望能在日後補上的方向（TODO）。

大致會像這樣：

# Outline
一、前言
二、標題甲
  2-1. 標題甲一
  2-2. 標題甲二
三、標題乙
四、小結
Ａ、參考資料
Ｂ、待敘項目（TODO）

# TL;DR
把一篇很長的文章，縮短成簡單的三兩句話，讓人快速抓住文章的精華。

2-2. 指令簡介

在介紹到某個 Git 指令時，會在文章中放置這樣的一個程式碼區塊讓讀者可以輔助參照：

# Command Synopsis: dotnet-new
dotnet new <tempalate> [options] 

三、範例專案與程式碼

本系列文專案目前有一個搭配的範例專案 dotnet-core-ci-cd-lab。用來記錄本系列文各個實驗、示範。

會建議將兩個專案都 clone 在同一個目錄下，然後各取名為 lab 和 dotgit，本系列文在目錄的表示也都會以這樣為主。可以參照下面範例程式碼操作：

# Location: ~
$ mkdir dotnet-core-ci-cd
$ cd dotnet-core-ci-cd

# Location: ~/dotnet-core-ci-cd
$ git clone https://github.com/fntsrlike/dotnet-core-ci-cd-lab.git lab

在每段範例程式碼中，都會用 # 作為註解，標示一些資訊，如下：

# Snapshot: 61d0acc @ lab
# Location: ~/dotnet-core-ci-cd
$ mkdir lab
$ cd lab

# Location: ~/dotnet-core-ci-cd/lab
$ dotnet new sln -n "dotnet-lab" -o ./
$ ls
dotnet-lab.sln

• 以 # Snapshot: 作為開頭的，是指這段範例程式碼是位於哪個範例專案的哪個 commit 中。
• 以 # Location: 作為開頭的，是指當前命令列所在的位置。~ 是 UNIX 作業系統的表示法，代表的是當前使用者的 home 目錄，以本系列文為例就是 /Users/ironman/。

四、建議閱讀順序

1. 前言與創作方向
2. README
3. .NET Core 版本生命週期
4. .NET Core CLI：安裝
5. .NET Core CLI：建立專案
6. .NET Core CLI：管理 NuGet 套件
7. .NET Core CLI：restore、build 與 test 行為關係
8. Concept：我們該持續整合什麼？
9. Concept：持續整合、交付、部署、釋出
10. Local CI：Code Linter
11. Local CI：在 git commit 前，自動執行測試
12. Local CI：Code Coverage
13. Local CI：Acceptance Testing
14. Local CI：環境
15. Local CI：發佈
16. Local CI：版本號
17. Local CI：自動產生 API 文件
18. Local CI：透過 Docker 建置 .NET Core 專案
19. GitLab CI - Runner 以及初始設定檔案
20. GitLab CI - 加入測試和覆蓋率