Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements for onboarding #6266

Open
dmccown opened this issue Mar 5, 2019 · 3 comments
Open

Documentation improvements for onboarding #6266

dmccown opened this issue Mar 5, 2019 · 3 comments
Labels
Documentation Flags an issue / PR for attention by the technical documentation team Focus:Supervisor Related to the Habitat Supervisor (core/hab-sup) component Type:Additional Discussion Type: Feature Issues that describe a new desired feature

Comments

@dmccown
Copy link

dmccown commented Mar 5, 2019

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.
@bdangit
Copy link
Contributor

bdangit commented Mar 6, 2019

One thing I have noticed is that my early adopters at my work see a bunch of “random” text and have not clue how it relates to the plan build. All that is expected is as long as they see the successful banner they know they didn’t break anything.

However when things break, they choke and don’t know exactly where in the plan broke.

All in all, there is too much stdout. It would be nice that to:

  1. Emphasis clearly what phase is being run (bold text, uppercase, brackets?)
  2. Making things less verbose (at least the automatic stuff could be hidden to extent).

@stale
Copy link

stale bot commented Apr 2, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. We value your input and contribution. Please leave a comment if this issue still affects you.

@stale stale bot added the Stale label Apr 2, 2020
@stale stale bot removed the Stale label Apr 27, 2020
@christophermaier christophermaier added Focus:Supervisor Related to the Habitat Supervisor (core/hab-sup) component Type: Feature Issues that describe a new desired feature and removed A-supervisor labels Jul 24, 2020
@christophermaier christophermaier added Documentation Flags an issue / PR for attention by the technical documentation team and removed A-documentation labels Aug 18, 2020
@rahulgoel1 rahulgoel1 removed the V-sup label Jul 23, 2021
@stale
Copy link

stale bot commented Oct 16, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. We value your input and contribution. Please leave a comment if this issue still affects you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Flags an issue / PR for attention by the technical documentation team Focus:Supervisor Related to the Habitat Supervisor (core/hab-sup) component Type:Additional Discussion Type: Feature Issues that describe a new desired feature
Projects
None yet
Development

No branches or pull requests

5 participants