Skip to content

Clarify module variable cleanup - #26

Merged
El-Limon merged 1 commit into
mainfrom
docs/module-variable-cleanup
May 23, 2026
Merged

El-Limon merged 1 commit into
mainfrom
docs/module-variable-cleanup

Conversation

@El-Limon

Copy link
Copy Markdown
Contributor

Summary

This updates the module docs to make variable cleanup behavior explicit. Uninstalling a module removes the game server installation and config, but it does not delete variables created by that module.

The change also points users to the Advanced Variables deletion pattern and adds an example for deleting module-scoped variables by ID.

What Changed

  • Module install docs: Clarified that uninstalling removes the installation/configuration only, and that module variables remain until deleted separately.
  • Module debugging docs: Added a pointer to delete relevant variables when saved module data needs cleanup.
  • Advanced Variables docs: Added a module cleanup example that searches by gameServerId and moduleId, then deletes each variable by ID.

Reviewer Guide

  • Start here: docs/modules/install-configure.md, especially the "Remove a module" section.
  • Pay attention to: The wording around uninstall behavior. It should match the service behavior where uninstall deletes the installation row, not variables.

Testing Plan

Happy Path

  • Open the Modules install/configure page and verify the uninstall section clearly says variables are not deleted.
  • Open Advanced > Variables and verify the deletion example explains search-then-delete by variable ID.

Regression Checks

  • Confirm links to /advanced/variables#deleting-a-variable resolve.
  • Confirm the docs build passes.

Verified locally with npm run build.

@El-Limon El-Limon added the documentation Improvements or additions to documentation label May 23, 2026
@El-Limon
El-Limon merged commit 0d2db3a into main May 23, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant