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

Đang mở
  • Có gì không ổn?
#1,368 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
shell
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
0
Fork
4
Merge trung bình
5 giờ 36 phút
Pull request đã merge (30 ngày)
509

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Controlvar/controlvar

Tất cả issue của Controlvar/controlvar

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.