-
Notifications
You must be signed in to change notification settings - Fork 319
Open
Labels
DocumentationFlags an issue / PR for attention by the technical documentation teamFlags an issue / PR for attention by the technical documentation teamFocus:SupervisorRelated to the Habitat Supervisor (core/hab-sup) componentRelated to the Habitat Supervisor (core/hab-sup) componentType: FeatureIssues that describe a new desired featureIssues that describe a new desired featureType:Additional Discussion
Description
Description
First time users of Habitat have a hard time getting started. There's a number of documentation improvements we could do to ease their onboarding.
- Publish a state machine for all Habitat related hooks. Indicate when and what order hooks will run in.
- Publish a state machine for all build steps a user would expect to interact with in plan.sh (or plan.ps1). Indicate what order they run and when you should override them.
- It should be easy to find what you're looking for in the documentation.
- Varbiable documentation. It's very hard to understand under which context which variables are available and what you should use them for.
Metadata
Metadata
Assignees
Labels
DocumentationFlags an issue / PR for attention by the technical documentation teamFlags an issue / PR for attention by the technical documentation teamFocus:SupervisorRelated to the Habitat Supervisor (core/hab-sup) componentRelated to the Habitat Supervisor (core/hab-sup) componentType: FeatureIssues that describe a new desired featureIssues that describe a new desired featureType:Additional Discussion