Skip to content

Add charting tutorial #21

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

Merged
merged 19 commits into from
May 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ can find a preview of the new documentation at
- [ ] Do CSS magic to fuse subsequent TQL code blocks
- [x] Apply CSS and get a facelift
- [ ] Style Asides to match design system
- [ ] Add our favicon

### Changelog

Expand Down
55 changes: 49 additions & 6 deletions src/content/docs/guides/contribution/documentation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Tenzir documentation resides at https://github.com/tenzir/docs.
We use [Astro](https://astro.build) with
[Starlight](https://starlight.astro.build) as website framework.

## Develop and view locally
## Develop and View Locally

Install web framework dependencies:

Expand All @@ -22,7 +22,7 @@ pnpm dev

Then browse to http://localhost:4321/ to view the site.

## Build for production
## Build for Production

Create a production build as follows:

Expand All @@ -42,7 +42,50 @@ We create a production build in CI. Check out our [GitHub
workflow](https://github.com/tenzir/docs/blob/main/.github/workflows/docs.yaml)
for the gory details.

## Edit diagrams
## Optimize Images

To keep the repository size manageable, always optimize image files *before*
committing them. This is especially important for formats like PNG, which can
contain unnecessary metadata or use inefficient compression.

### PNG Images

We recommend using [pngquant](https://pngquant.org/), a command-line utility
for lossy compression of PNG files. It significantly reduces file size while
preserving image quality.

To compress a PNG file in-place:

```bash
pngquant --ext .png --force --quality=65-80 image.png
```

### JPEG Images

Use [jpegoptim](https://github.com/tjko/jpegoptim), a utility for optimizing
JPEGs without perceptible quality loss:

```bash
jpegoptim --strip-all --max=80 image.jpg
```

Alternatively, you can use [mozjpeg](https://github.com/mozilla/mozjpeg) for
even better compression ratios.

### SVG Images

Use [svgo](https://github.com/svg/svgo), a Node-based tool to optimize SVG files
by removing unnecessary data:


```bash
svgo image.svg
```

This automatically rewrites the file in-place with redundant code removed and
optimized structure.

## Edit Diagrams

We use [Excalidraw](https://excalidraw.com) as primary tool to create sketches
of architectural diagrams.
Expand All @@ -51,7 +94,7 @@ When exporting Excalidraw scenes, always **use light mode** and **choose SVG**
as export format, as we have some CSS magic in place that automatically inverts
colors SVGs so that they also look nicely when using dark mode.

Tenzir developers have access to our Exalidraw [Documentation
Tenzir developers have access to our Excalidraw [Documentation
collection](https://app.excalidraw.com/o/6dBWEFf9h1l/9RErQkL9e2v). For everyone
else, we encourage to reach out to us on our [Discord server](/discord) to
request changes to existing SVGs.
else, please reach out to us on our [Discord server](/discord) to request
changes to existing SVGs.
4 changes: 2 additions & 2 deletions src/content/docs/tutorials/map-data-to-ocsf.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: Map Data to OCSF
---

In this tutorial you'll learn how to map events to [Open Cybersecurity Schema
Framework (OCSF)](https://schema.ocsf.io). We walk you through an example of
In this tutorial you'll learn how to **map events to [Open Cybersecurity Schema
Framework (OCSF)](https://schema.ocsf.io)**. We walk you through an example of
events from a network monitor and show how you can use Tenzir pipelines to
easily transform them so that they become OCSF-compliant events.

Expand Down
Loading