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

Move Zeek docs to Integrations area #4694

Merged
merged 7 commits into from Jul 3, 2023
Merged

Move Zeek docs to Integrations area #4694

merged 7 commits into from Jul 3, 2023

Conversation

philrz
Copy link
Contributor

@philrz philrz commented Jul 3, 2023

I've spotted some material changes I'd like to make to our docs about how Zed works with Zeek. These have been in living in a separate spot away from the other Zed docs, which I believe was motivated by an instinct to create some separation from tooling's prior Zeek-centric focus. However, we now have an Integrations area in the Zed docs where it feels like these could safely live such that they'd benefit from the better rendering in Docusaurus and they'd also be easier for readers to find but still be clearly separate from the core Zed mission. This PR just takes care of moving them to the new location and updating the formatting/links. Once this merges I'll put up a follow-on PR with actual material changes to the content.

If you want to see how it looks rendered, I've put a copy of on a personal staging site at https://spiffy-gnome-8f2834.netlify.app/docs/next/integrations/zeek.

@philrz philrz requested a review from a team July 3, 2023 18:00
@philrz philrz self-assigned this Jul 3, 2023
@nwt
Copy link
Member

nwt commented Jul 3, 2023

zio/zeekio/ is all about Zeek TSV I/O, so it doesn't feel like the right place for shaper.zed and its test. How about embedding them in shaping-zeek-ndjson.md as a fenced code block (for the shaper) and mdtest?

@philrz
Copy link
Contributor Author

philrz commented Jul 3, 2023

@nwt: Ok, I've followed your recommendation and moved the shaper.zed into the markdown and created an mdtest to replicate what was formerly in the ztest. As we discussed offline, that iteration of the shaper.zed is particularly huge but I have plans to shorten it significantly in the changes I have coming up along with a wider overhaul of that doc about shaping Zeek, so try not to get too caught up in its present contents.

@philrz philrz requested a review from nwt July 3, 2023 22:09
Copy link
Member

@nwt nwt left a comment

Choose a reason for hiding this comment

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

:shipit:

@philrz philrz merged commit b64b80c into main Jul 3, 2023
4 checks passed
@philrz philrz deleted the zeek-integration-docs branch July 3, 2023 22:34
@philrz philrz mentioned this pull request Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants