guardicore / guardicore/monkey

Add server_config.json reference documentation

Open
#4,216 2 comments 0 reactions 1 assignee Claimed by @shreyamalviya View on GitHub
Documentation
Dominant language
Python
Stars
7.1k
Forks
830
PR merge metrics
No merged PRs in 30d

Description

## Edit existing documentation 📝

### Page to edit
/reference/server-configuration

### Required changes
Improve reference documentation for the `server_config.json` file. Use [jsonschema2md](https://github.com/adobe/jsonschema2md) to generate markdown documentation for the server_config.json. Note that some elements from the markdown will need to be manually removed (see /reference/payloads/ransomware and /reference/payloads/cryptojacker for an example). You can use the script shown below under "Resources" to dump the plugin's Pydantic options model to JSON. You may need to add details, such as descriptions, to the Pydantic model.

### Resources

[jsonschema2md](https://github.com/adobe/jsonschema2md)
[Diátaxis](https://diataxis.fr/)
```python
import json
from src._options import Options

print(json.dumps(Options.model_json_schema(), indent=2))
```

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.