Project

General

Profile

Actions

User story #12630

closed

Architecture #12907: Build a centralized place for doc: docs.rudder.io

Add a "first steps" guide for new users

Added by Alexis Mousset over 6 years ago. Updated about 6 years ago.

Status:
Released
Priority:
N/A
Category:
Documentation
Target version:
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

based on gitbook.

Provide a detailed structure and CI infra.

The idea of the guide is to assist new users of Rudder in the first steps with the product. Start with a pre-installed environment (vbox images) to avoid that part, and then present Rudder not throught a reference manual (as today), but throught a story: this is what you do with Rudder. See, this a system configuration. You apply it and get feed back. You can create new one. You can apply it to nodes. Nodes have properties that can be used to tailor applied configuration. Look, you can do more complexe configuration like application deployment.

The guide must be short (manageable in 1h of free time or so - with a first part that present the most important things reachable in 15-20min), and extremelly attentive to user understanding of the different steps and the transition between them. It would help if the guide was coming with something always remaining the user of the current step / current goal.


Subtasks 6 (0 open6 closed)

User story #12699: Add content is the get-started guideReleasedAlexis MoussetActions
User story #12871: Build antora build errorReleasedFrançois ARMANDActions
User story #12873: Improve get-started contentReleasedFrançois ARMANDActions
User story #13000: Improve get-started contentReleasedFrançois ARMANDActions
User story #12876: Create a Rudder theme for antoraRejectedRaphael GAUTHIERActions
User story #12877: Add relevant links to antora headerReleasedFrançois ARMANDActions

Related issues 1 (0 open1 closed)

Has duplicate Rudder - User story #7688: Add a getting started section in the manualRejectedAlexis MoussetActions
Actions #1

Updated by Benoît PECCATTE over 6 years ago

We need more info: a guide of what ? whith which content ?

Actions #2

Updated by François ARMAND over 6 years ago

  • Subject changed from Add a guide for new users to Add a "first steps" guide for new users
  • Description updated (diff)
Actions #3

Updated by Alexis Mousset over 6 years ago

  • Status changed from New to In progress
Actions #4

Updated by Alexis Mousset over 6 years ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Alexis Mousset to Benoît PECCATTE
  • Pull Request set to https://github.com/Normation/rudder-doc/pull/414
Actions #5

Updated by Alexis Mousset over 6 years ago

  • Status changed from Pending technical review to Pending release
Actions #6

Updated by Alexis Mousset over 6 years ago

  • Has duplicate User story #7688: Add a getting started section in the manual added
Actions #7

Updated by Alexis Mousset over 6 years ago

  • Parent task set to #12907
Actions #8

Updated by Vincent MEMBRÉ about 6 years ago

  • Status changed from Pending release to Released
This bug has been fixed in Rudder 5.0.0~beta1 which was released today.
Changelog
Actions

Also available in: Atom PDF