Strider-CD/strider

Finish Guides setup

Open

#1.007 geöffnet am 6. Dez. 2016

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (4.587 Stars) (454 Forks)batch import
documentationenhancementgood for beginnershelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
MarkdownGitNode.js
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75
Research-Richtung
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.