Tutorials

Tutorials should take a reader from start to finish with a concrete outcome.

Core tutorial tracks

1. Configure a new client environment

1. Start with the relevant example implementation.
2. Set or update the environment-specific parameter values.
3. Validate the deployment inputs before rollout.
4. Record any environment-specific assumptions in the docs.

2. Modify existing infrastructure safely

1. Change the parameter surface before editing the shared template.
2. Validate the template locally.
3. Confirm backward compatibility and rollout impact.

3. Add or update a data contract

1. Start in Rockdata Data Contracts to confirm the intended model shape.
2. Update the matching contract files in the example implementation.
3. Validate the contract with representative test data.
4. Confirm the downstream Bronze and Silver behavior still matches the contract intent.

4. Update notebooks or jobs in the example implementation

1. Identify the notebook or job entry point in the relevant example folder.
2. Keep the change aligned with the contract-defined behavior.
3. Validate the execution path with a small representative run.
4. Update any affected docs or operational notes.

5. Debug a quarantine-heavy Silver run

1. Separate casting failures from constraint failures.
2. Inspect failure reasons and contract assumptions.
3. Confirm whether the issue is shared logic or platform execution.
4. Capture the resolved workflow in docs if it was missing.