Skip to content

Documentation improvements for onboarding #6266

@dmccown

Description

@dmccown

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

No one assigned

    Labels

    DocumentationFlags an issue / PR for attention by the technical documentation teamFocus:SupervisorRelated to the Habitat Supervisor (core/hab-sup) componentType: FeatureIssues that describe a new desired featureType:Additional Discussion

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions