docs: developer guides for config, runners, and HA cluster#3910
Draft
cursor[bot] wants to merge 1 commit into
Draft
docs: developer guides for config, runners, and HA cluster#3910cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
Document recently evolved subsystems that lacked in-repo guides: configuration (JSON/YAML, schema, env overrides), runner tag routing, and the admin cluster dashboard API. Link from CONTRIBUTING and README. Co-authored-by: Denis Gukov <fiftin@outlook.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds in-repo developer documentation for subsystems that changed recently but only had scattered plans or test cases.
Docs added/updated
docs/README.mddocs/configuration.mdconfig.json/config.yaml, discovery paths, env overrides,config.schema.yaml, TLS redirect, MFA renamedocs/runners-and-tags.mddocs/cluster-dashboard.md/api/cluster*endpoints, task snapshot, maintenance clearCONTRIBUTING.mdREADME.md.github/copilot-instructions.mddocs/pointersCodepaths covered
util/config.go— config load order, file discovery, TLS redirect, HAutil/config_auth.go—mfablockservices/tasks/RemoteJob.go,TaskPool.go— runner tag routingapi/cluster.go,api/router.go— cluster dashboard APIweb/src/views/Cluster.vue— HA UI behaviorKnowledge gaps addressed
config.schema.yamlusage for contributorsDELETE /api/cluster/taskswere undocumented outside commented SwaggerDocumentation-only change; verified against source, no runtime behavior changes.