apify-docs icon indicating copy to clipboard operation
apify-docs copied to clipboard

feat(platform): add documentation for scoped API tokens

Open tobice opened this issue 1 year ago • 5 comments

We're adding public facing documentation for a new feature, tokens with limited permissions, aka scoped tokens.

Full context is available in the design doc.

tobice avatar Aug 13 '24 14:08 tobice

Hey folks, asking for early review. What's missing are screenshots, which I won't be able to provide before we finish the UI. However, the copy is final (= ready for review) from my PoV.

Also tagged @jirimoravcik as he is only semi-familiar with the project, so he'll be able to give useful feedback if the documentation is easy to understand / sufficiently detailed.

tobice avatar Aug 13 '24 14:08 tobice

Updated the documentation:

  • Added short instructions on how to create a scoped token
  • Added 2 temporary screenshots, to be replaced with the actual ones once the UI is finished (I see no other use cases for screenshots)
  • Unified callouts to use note across the board
  • Minor copy changes

tobice avatar Aug 14 '24 09:08 tobice

Currently the docs are missing [...], and what all the various permissions are.

Agreed with Franta that this is not necessary.

I also think the API page should be displayed more prominently, not just two levels deep in Integrations, where it gets a bit lost. But that's a problem for another task.

Hmm I guess. cc @TC-MO

tobice avatar Aug 14 '24 09:08 tobice

Cool, thanks for the review :heart:

Let's wait now for Kuba and for how we decide to proceed with the UI. This means that the PR will stay open for a while.

tobice avatar Aug 14 '24 12:08 tobice

Changes look good, let's wait to final design implementation.

drobnikj avatar Aug 15 '24 12:08 drobnikj

Uploaded new screenshots that use the new UI. Feel free to check it out @drobnikj

tobice avatar Aug 23 '24 07:08 tobice

Alright, this PR is pretty much ready.

We synced with @TC-MO and made some changes together:

  • We got rid of some of the gerunds in headings
  • We kept the generic admotion titles ("Tip" / "Note") to see if people like them

I resolved all the pending conversions which were related to these topics.

@TC-MO @drobnikj feel free to take a look and approve :pray:

tobice avatar Aug 23 '24 13:08 tobice

I merged the public release to develop today, we can manage it to prod today. Let's merge this @tobice

drobnikj avatar Sep 03 '24 08:09 drobnikj

Won't make it to today's release. Lets's merge it tomorrow.

tobice avatar Sep 03 '24 08:09 tobice