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

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

Merged
merged 2 commits into from
May 15, 2024

Conversation

philrz
Copy link
Contributor

@philrz philrz commented May 14, 2024

With the merge of brimdata/zui#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 philrz requested a review from a team May 14, 2024 18:51
@philrz philrz self-assigned this May 14, 2024
Copy link
Collaborator

@mattnibs mattnibs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! You wanted to add this to the manage command line instructions as well?

@philrz
Copy link
Contributor Author

philrz commented May 14, 2024

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. 😅

@philrz philrz requested a review from mattnibs May 14, 2024 23:06
@mattnibs
Copy link
Collaborator

@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. ..

@philrz philrz merged commit e5ab915 into main May 15, 2024
4 checks passed
@philrz philrz deleted the zed-serve-manage-docs branch May 15, 2024 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants