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

Add server_config.json reference documentation #4216

Open
mssalvatore opened this issue Jun 20, 2024 · 2 comments · May be fixed by #4274
Open

Add server_config.json reference documentation #4216

mssalvatore opened this issue Jun 20, 2024 · 2 comments · May be fixed by #4274
Assignees
Labels
Documentation Issues relating to the project's documentation like readme files, guides, etc.

Comments

@mssalvatore
Copy link
Collaborator

mssalvatore commented Jun 20, 2024

Edit existing documentation 📝

Page to edit

/reference/server-configuration

Required changes

Improve reference documentation for the server_config.json file. Use 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
Diátaxis

import json
from src.<PLUGIN>_options import <PLUGIN>Options

print(json.dumps(<PLUGIN>Options.model_json_schema(), indent=2))
@mssalvatore mssalvatore added the Documentation Issues relating to the project's documentation like readme files, guides, etc. label Jun 20, 2024
@VakarisZ
Copy link
Contributor

Related: #4239

@shreyamalviya
Copy link
Contributor

Generating markdown documentation for IslandConfigOptions using jsonschema2md is difficult because of this issue.

@shreyamalviya shreyamalviya self-assigned this Aug 13, 2024
@shreyamalviya shreyamalviya linked a pull request Aug 13, 2024 that will close this issue
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues relating to the project's documentation like readme files, guides, etc.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants