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

未关闭
#1,368 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
shell
领域
documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Python
星标
0
派生
4
平均合并
5 小时 19 分钟
30 天内合并 PR
503

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Controlvar/controlvar 的其他 Issue

查看 Controlvar/controlvar 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。