docs: add developer guides for recent subsystems#3967
Draft
cursor[bot] wants to merge 1 commit into
Draft
Conversation
Add in-repo docs/ with guides for configuration, runners, executors, workflows, task pagination, and HA cluster operations. Update CONTRIBUTING and README to link the new index. Refresh api-docs.yml for keyset pagination on GET .../tasks/last. 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 an in-repo
docs/directory for contributors and operators, covering subsystems that recently evolved but lacked consolidated developer documentation.Docs added/updated
docs/README.mddocs/configuration.mddocs/runners-and-tags.mddocs/runner-executors.mddocs/workflows.mddocs/tasks-api-pagination.mddocs/cluster-dashboard.mdCONTRIBUTING.mddocs/README.mdapi-docs.ymlGET .../tasks/lastkeyset pagination params andX-Has-NextheaderCodepaths covered
util/config.go,services/runners/executor_factory.go,pro/services/tasks/k8s/,pro/services/tasks/docker/db/Workflow.go,pro_interfaces/workflow_*.go,pro_impl/services/server/workflow_svc.go, workflow API routesapi/projects/tasks.go,db/sql/task.go,web/src/views/project/History.vueservices/tasks/RemoteJob.go,services/tasks/runner_reconciler.go,runnersconfig blockapi/cluster.go,services/tasks/task_state_store.goKnowledge gaps addressed
AGENTS/plans/notes but no contributor-facing overviewbefore,X-Has-Next) was implemented but swagger still described "last 200 tasks"runners.offline_timeout_sec, etc.) were not documented for operators