Guided examples: walk the demo apps through a team's first-week tasks, every step run end to end

Abierto
  • ¿Algo no está bien?
#1,368 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
shell
Área
documentation

Línea de trabajo

Start by reading demo/setup-local.sh and the planned journeys under tests/acceptance/docs/journeys/, then inspect tests/acceptance/docs/inventory.toml and the docs-journeys workflow. The final walkthrough list and reviewed design must be agreed before implementation because dependent demo-app fixes are still in review. Done means every selected journey has expected results, runs end to end against the demo stack, and is either documented on the page or explicitly marked as not walked.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation

What

A "Guided examples" page in the user guide. It holds short walkthroughs of what a team does in its first weeks, on the two demo apps that demo/setup-local.sh starts: ShopLab (a storefront) and StreamPulse (a streaming app). Candidates:

  • run an A/B test on the storefront, then read its result;
  • end the test and ship the winner behind a feature flag;
  • roll a feature out in stages, and watch the safety monitor roll it back when crashes spike;
  • target a feature by device and app version (web SDK).

The plan sets the final list.

Requirement: everything on the page runs end to end

  • Each walkthrough is a docs journey (tests/acceptance/docs/journeys/), with its expected results written before its first run.
  • The docs-journeys workflow walks every journey against the demo stack.
  • The page is classed journey in tests/acceptance/docs/inventory.toml.
  • Anything that cannot run on the local demo stack is either left out or marked on the page as not walked. That includes the native mobile SDKs, cloud deployment and SSO.

Depends on

The demo-app fixes now in review:

  • #1358: late conversions are still sent;
  • #1359 and #1362: a paused or completed experiment answers control with a reason;
  • the nightly ShopLab journey reading results.

The page describes the behaviour after those merge.

Process

A reviewed plan (design, verification, and the words readers see) comes before any build.

Lenguaje dominante
Python
Estrellas
0
Forks
4
Merge medio
5 h 19 min
PR fusionados (30 d)
503

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Controlvar/controlvar

Todos los issues de Controlvar/controlvar

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.