Strider-CD/strider

Finish Guides setup

Open

#1,007 opened on Dec 6, 2016

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

Repository metrics

Stars
 (4,587 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the docs folder structure, add missing sections to navigation, fix image links, clean up intro/conclusions in each post, add attribution to FutureStudios, and perform spell check. Use docpress to serve and test locally.
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-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitdocpress
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75