habitat icon indicating copy to clipboard operation
habitat copied to clipboard

Display callbacks in execution order at top and then enhance descriptions

Open burtlo opened this issue 6 years ago • 3 comments

The documentation (https://www.habitat.sh/docs/reference/callbacks/) shows them in the execution order. That is extremely helpful. I would like to see the callbacks introduced in their execution order and then below that focus on details about each of the callbacks.

The more detailed descriptions should make it clearer which callbacks you should / must override, include examples of their uses, and provide any specific contextual data (e.g. current working directory and helper methods). A visualization of what is taking place around each of the callbacks would help give a better context of the current state (when a directory is created).

A reference to the build variables and utility functions should be added to the page (https://www.habitat.sh/docs/reference/build-variables/ and https://www.habitat.sh/docs/reference/utility-functions/) as those values are often used within these callbacks.

burtlo avatar Sep 15 '17 11:09 burtlo

I can do part of this, the rest will need a different set of eyes.

  • [ ] The more detailed descriptions should make it clearer which callbacks you should / must override, include examples of their uses, and provide any specific contextual data (e.g. current working directory and helper methods).
  • [ ] A visualization of what is taking place around each of the callbacks would help give a better context of the current state (when a directory is created). << I wonder if this might be better served as a blog so the reference documentation still is easily browsable for regular users.
  • [x] Add a reference to build variables & utility functions

tashimi avatar Sep 17 '17 02:09 tashimi

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[bot] avatar Apr 03 '20 01:04 stale[bot]

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[bot] avatar Aug 12 '22 00:08 stale[bot]