Strider-CD/strider

Finish Guides setup

Open

#1007 opened on Dec 6, 2016

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (4,587 stars) (454 forks)batch import
documentationenhancementgood for beginnershelp wanted

Description

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.

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
MarkdownGitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
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.