search

brimdata / zed

A novel data lake based on super-structured data
https://zed.brimdata.io/
BSD 3-Clause "New" or "Revised" License
1.34k stars 67 forks source link

Reference the "zed serve -manage" option in zed command docs #5124

Closed philrz closed 1 month ago

philrz commented 1 month ago

With the merge of https://github.com/brimdata/zui/pull/3006 and wanting to generally be able to point users at the benefits of compaction when they have lots of small commits, I realized the docs could stand to mention the availability of the zed serve -manage option since I expect many users would prefer this over having to run zed manage as a separate process.

philrz commented 1 month ago

Thanks @mattnibs. Good idea. I just pushed another commit to add the zed manage command help. I ended up basically taking the text from the docs site verbatim. Then I noticed that the zed serve command help was somewhat out of date, so I did the same there.

That all got me to thinking how the true docs nerd thing to do might be to "single source" the content in some way so that both the docs site and the command help could be more easily kept in sync. But I can foresee just enough complexity with doing that properly that I'm prepared to put it off for another time. 😅

mattnibs commented 1 month ago

@philrz indeed it would be nice to have a single source for docs and cli help. I know that cobra allows you to output your cli help to markdown docs. ..