guardicore / guardicore/monkey

Configuration reference documentation

Open
#711 0 comments 0 reactions 1 assignee Claimed by @VakarisZ View on GitHub
Complexity: Low Documentation Impact: Low
Dominant language
Python
Stars
7.1k
Forks
830
PR merge metrics
No merged PRs in 30d

Description

## Documentation request

### Add a new page 🆕

**What documentation you'd like us to add?**

1. Add a reference for all (non-internal) configurable values for users.
1. Add a shortcode `<<% config value_name %>>` which creates an automatic label+link(+hoverbox?) to the reference whenever we use a config value in the documentation somewhere (for example scenarios page). Something like

```html

{{ .Params 0 }}
```

**Where in the documentation tree?**

A new section called "reference", or "Usage".

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.