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

docs: create 'concepts' page on scopes #358

Merged
merged 1 commit into from
Oct 17, 2023
Merged

Conversation

ahal
Copy link
Collaborator

@ahal ahal commented Oct 13, 2023

@ahal ahal requested a review from a team October 13, 2023 20:00
@ahal ahal self-assigned this Oct 13, 2023
@ahal ahal requested a review from gabrielBusta October 13, 2023 20:00
@ahal
Copy link
Collaborator Author

ahal commented Oct 13, 2023

@matt-boris @petemoore @lotas hey TC team, I wrote up this doc because I realized that even I was feeling fuzzy on how scopes actually work under the hood. Could one of you do a quick proof read of the Queue and Auth Services section just to make sure I have it more or less right?

@ahal ahal requested review from lotas and removed request for lotas October 13, 2023 20:12
Copy link
Contributor

@bhearsum bhearsum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a very nice overview, thanks for writing it!

Two things you could consider also adding here:

  • A brief bit on how scopes and decision tasks relate. Eg: that a decision task itself must have all of the scopes for all of the tasks that will create, and then the individual tasks are only granted the specific things they need. (I found this surprising and a bit confusing when I learned about it.)
  • A brief explanation of roles

If you think either of these are out of scope or too in the weeds that's totally fine.

docs/concepts/scopes.rst Outdated Show resolved Hide resolved
@ahal
Copy link
Collaborator Author

ahal commented Oct 17, 2023

Thanks for the suggestions, I incorporated them in!

@ahal ahal merged commit 492d5a6 into taskcluster:main Oct 17, 2023
@ahal ahal deleted the scopes_doc branch October 17, 2023 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants