Strider-CD/strider

Finish Guides setup

Open

#1,007 建立於 2016年12月6日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)JavaScript (4,587 star) (454 fork)batch import
documentationenhancementgood for beginnershelp wanted

描述

FutureStudios via @marcuspoehls has given us permission to move/adapt their Strider blog post series into our website. This has been started here: https://github.com/Strider-CD/strider/tree/master/docs but still needs more work:

  • Add all sections to nav (see README in docs folder)
  • Fix image links in all posts
  • Cleanup all post intro and conclusions that mention the series or future studios
  • Add an attribution to futurestudios
  • General cleanup/spell check

Writing and Testing Docs

To serve the docs install docpress and:

cd strider
docpress s

Open http://localhost:3000, and this will also watch for changes and recompute or give errors in the terminal.

貢獻者指南

技術棧
javascript
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
MarkdownGitNode.js
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
The docs are in the 'docs' folder of the Strider repository. The issue references a blog post series from FutureStudios that should be adapted. The README in the docs folder contains navigation structure. To view changes locally, install docpress (https://docpress.github.io/) and run 'docpress s' from the project root. Contributors should port the blog content, fix image links, and add attribution following the existing style.