docs: update help text for "accept limit" for schema app creation #579
Conversation
🦋 Changeset detectedLatest commit: 15f1147 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| helpText: 'Enter the maximum number of installs you want to allow for the invitation.\n' + | ||
| 'This limits the number of installs but we use the "accept" terminology here to match the API call.\n' + | ||
| 'There is also a limit of 30 days that cannot be changed. After that you will need to create a new invitation.\n' + | ||
| 'Leave blank for a maximum of 500.', |
There was a problem hiding this comment.
Here's a suggestion for alternate wording:
Invitations are limited to a maximum of 500 installations (called "accept"s by the API) and are only valid for 30 days.
Once either the install limit or the time limit is reached, you will need to create a new invitation.
Leave blank to accept the maximum install limit or enter a smaller cap if desired.
The format of this suggested wording may be too different from our other help text to be used. And I'm not entirely sure it's better than what you already have. But I think having so much other information between "Enter the..." and "Leave blank for..." has the potential to be confusing.
There was a problem hiding this comment.
I double-checked and 500 is just the default, not the absolute maximum. How about this text?
Invitations are limited to a maximum of 500 installations by default (called "accept"s by the API) and are only valid for 30 days.
Once either the install limit or the time limit is reached, you will need to create a new invitation.
Leave blank to accept the default or enter a different install limit if desired.
There was a problem hiding this comment.
If the API doesn't mention the word "installations" anywhere, would it be beneficial to forgo using "installations" in the CLI help text to avoid introducing a new term?
Invitations are limited to a maximum of 500 acceptances by default and are valid for 30 days.
Once either the accept limit or the time limit is reached, you will need to create a new invitation.
Leave blank to accept the default limit of 500, or enter a different acceptance limit if desired.
I do think the word "installations" is more accurate here; I'm thinking a user could accept an invitation and install an app multiple times.
There was a problem hiding this comment.
Maybe add an extra sentence that defines "acceptance" so it's clear it's per-installation and not per-user?
An acceptance is when a user installs an app from your invitation; multiple installations count as multiple acceptances.
Invitations are limited to a maximum of 500 acceptances by default and are valid for 30 days.
Once either the accept limit or the time limit is reached, you will need to create a new invitation.
Leave blank to accept the default limit of 500, or enter a different acceptance limit if desired.
rossiam
force-pushed
the
schema-limit-update
branch
from
99d540f to
15f1147
Compare
Updated help text for the
acceptLimitfield in schema invitation creation to match new limit and new information.