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

feat: improve documentation for scoped tokens #1352

Merged
merged 4 commits into from
Dec 16, 2024

Conversation

tobice
Copy link
Contributor

@tobice tobice commented Dec 13, 2024

Changes:

  • Add documentation for the new switch that controls access to default run storages (related issue)
  • Add a Troubleshooting section that covers common pitfalls
  • Improve tone in certain parts (less harsh)
  • Standardize how permissions are referenced (always as Run, Write etc)

Some of the points are reflecting feedback from this thread.

@tobice tobice requested a review from drobnikj December 13, 2024 08:24
@tobice tobice self-assigned this Dec 13, 2024
@tobice tobice requested a review from TC-MO as a code owner December 13, 2024 08:24
@github-actions github-actions bot added this to the 104th sprint - Platform team milestone Dec 13, 2024
@github-actions github-actions bot added the t-platform Issues with this label are in the ownership of the platform team. label Dec 13, 2024
Copy link
Member

@drobnikj drobnikj left a comment

Choose a reason for hiding this comment

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

It looks there are old screens, can you pls update them when you are doing changes there?
image

sources/platform/integrations/programming/api.md Outdated Show resolved Hide resolved
sources/platform/integrations/programming/api.md Outdated Show resolved Hide resolved
sources/platform/integrations/programming/api.md Outdated Show resolved Hide resolved
sources/platform/integrations/programming/api.md Outdated Show resolved Hide resolved
sources/platform/integrations/programming/api.md Outdated Show resolved Hide resolved
sources/platform/integrations/programming/api.md Outdated Show resolved Hide resolved
sources/platform/integrations/programming/api.md Outdated Show resolved Hide resolved
sources/platform/integrations/programming/api.md Outdated Show resolved Hide resolved
sources/platform/integrations/programming/api.md Outdated Show resolved Hide resolved
@TC-MO
Copy link
Contributor

TC-MO commented Dec 13, 2024

I proposed some changes to prose & headings phrasing to get around Vale as well as just clean it up a little bit.

Msoft style guide states that punctuation should not be used within headings as well as to use first person as little as possible to tried to address those too.

I also proposed changes to how permissions are shown, since they are part of UI within console I advise to just bold them and reserve backticks for code notation.

Let me know if those changes make sense to you, or if you have any questions.

tobice and others added 2 commits December 13, 2024 13:13
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@tobice
Copy link
Contributor Author

tobice commented Dec 13, 2024

@drobnikj Update the screenshot 👍

@TC-MO Thanks for the suggestions! As discussed offline, keeping most of them as they are. Given the Slack discussion and how easily people get confused, I wanted to make it eye grabbing 😊

@tobice
Copy link
Contributor Author

tobice commented Dec 13, 2024

Also, I will only merge it on Monday after the next apify-core release.

@tobice tobice merged commit a9ccbbb into master Dec 16, 2024
8 checks passed
@tobice tobice deleted the tobik/feat/improve-scoped-token-docs branch December 16, 2024 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t-platform Issues with this label are in the ownership of the platform team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants