Closed Bug 1397373 Opened 7 years ago Closed 7 years ago

Move superseding docs out of docker-worker

Categories

(Taskcluster :: Services, enhancement)

enhancement
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: dustin, Assigned: dustin)

Details

      No description provided.
https://github.com/taskcluster/taskcluster-docs/pull/203

That should even out the score on review requests ;)

I could be convinced that the file I put in the queue's docs should be in the manual, but it is very reference-like.  The queue does implement the "superseded" reason, so it is not totally agnostic to superseding.
Assignee: nobody → dustin
(In reply to Dustin J. Mitchell [:dustin] from comment #4)
> https://github.com/taskcluster/taskcluster-docs/pull/203
> 
> That should even out the score on review requests ;)

Hah!

> I could be convinced that the file I put in the queue's docs should be in
> the manual, but it is very reference-like.  The queue does implement the
> "superseded" reason, so it is not totally agnostic to superseding.

I tend to lean towards having the queue docs just introduce the high level of what superseded reason is meant to represent, and refer to worker docs to see worker implementations. I do like the freedom that different workers can implement superseding differently (some might not even require a supersededUrl, e.g. if they are running as a web service like buildbot-bridge). It could otherwise appear as if our architecture forces workers to implement superseding like this, whereas they have more freedom to implement as they wish.

I agree it is a hard balance to strike between not overwhelming the user with implementation details, but also keeping the worker designs open to experimentation and alternative implementation strategies.

I'd say let's have a face-to-face to decide how to proceed.
Commits pushed to master at https://github.com/taskcluster/taskcluster-docs

https://github.com/taskcluster/taskcluster-docs/commit/11632b95e520121e64d7c75fc6dddca2fc3fe2f5
Bug 1397373: general documentation of superseding, and other options for load

https://github.com/taskcluster/taskcluster-docs/commit/17d06621fd8f479403b3ae525027971e3607b93d
Merge pull request #203 from djmitche/bug1397373

Bug 1397373: general documentation of superseding, and other options …
Commits pushed to master at https://github.com/taskcluster/taskcluster-queue

https://github.com/taskcluster/taskcluster-queue/commit/5a6dc0d33956da0d72caa15b0934e2882de5cfce
Bug 1397373 - describe superseding in queue reference

This describes superseding as a convention, rather than a rule.

https://github.com/taskcluster/taskcluster-queue/commit/9b36857aa8f8f27515382b48e638e9754ebf5993
Merge pull request #196 from djmitche/bug1397373

Bug 1397373 - describe superseding in queue reference
Status: NEW → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
Component: Documentation → Services
You need to log in before you can comment on or make changes to this bug.