Avoid synopsis section in catalog README

Open phanimarupaka opened this issue 4 years ago • 1 comments

A command "synopsis" refers to the exact syntax used to describe a CLI. e.g.

https://kpt.dev/reference/pkg/get/

We're not using this word correctly in function usage. I suggest getting rid of Synopsis section and just having:

Overview FunctionConfig Examples

May 04 '21 00:05 phanimarupaka

@phanimarupaka This sounds like a renaming given that synopsis already covers function config.

@frankfarzan WDYT? EDIT: nvm. I found https://github.com/GoogleContainerTools/kpt/issues/1890#issuecomment-832297917

May 25 '21 17:05 mengqiy