cloudbeat icon indicating copy to clipboard operation
cloudbeat copied to clipboard

Documenting and cleanup script commands

Open kfirpeled opened this issue 3 years ago • 1 comments

Motivation

We wish to improve our productivity toolings by adding proper documentation for each command. Documenting the purpose and what the command does, along with it parameters and their formatting/ options.

Definition of done

  • [ ] Document the commands in justfile
  • [ ] Document the commands in mage file
  • [ ] Document the commands in make file
  • [ ] remove any irrelevant command
  • [ ] refactor command name to be more informative

Out of scope

  • Printing the documentation manual

kfirpeled avatar Oct 26 '22 09:10 kfirpeled

  • Related: https://github.com/elastic/cloudbeat/pull/616 (some cleanup and docs in justfile)

oren-zohar avatar Jan 02 '23 11:01 oren-zohar