-
Notifications
You must be signed in to change notification settings - Fork 76
chore(docs): Add dedicated page explaining how to manage FWF PATs #1582
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Thorsten Hans <[email protected]>
Signed-off-by: Thorsten Hans <[email protected]>
🚀 preview deployed successfully to Fermyon Cloud and available at https://fermyon-developer-pr-1582-kcss6hup.fermyon.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for putting this together! I left a few small suggestions.
|
||
## Generating a PAT | ||
|
||
To generate a new PAT, use the `spin aka auth token create` command. At least, you have to specify a name for your PAT. Without further ado, the PAT will expire after `30` days. You can customize the expiration using the `--expiration-days` (or `-e`) option. Also, an optional description could be provided using `--description` (or `-d`): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few sentence-clarity tweaks
To generate a new PAT, use the `spin aka auth token create` command. At least, you have to specify a name for your PAT. Without further ado, the PAT will expire after `30` days. You can customize the expiration using the `--expiration-days` (or `-e`) option. Also, an optional description could be provided using `--description` (or `-d`): | |
To generate a new PAT, use the `spin aka auth token create` command. You must specify a name for your PAT. By default, the PAT will expire after `30` days. You can customize the expiration using the `--expiration-days` (or `-e`) option. Also, an optional description could be provided using `--description` (or `-d`): |
$ spin aka auth token list --format yaml | ||
``` | ||
|
||
For the sake of this article, will tell the command to produce the output as `YAML` instead of using the standard table layout to increase readability. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit, may want to include this comment before the command.
|
||
<!-- @nocpy --> | ||
|
||
```console |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be helpful to include one other fictional PAT to illustrate the list functionality?
|
||
If a previously generated PAT is about to expire, you can use the `spin aka auth token regenerate` command for regenerating a particular token using its identifier. You can find the identifier by [listing all your PATs](#listing-all-your-pats). | ||
|
||
Expiration in days can't be overwritten when regenerating a PAT. Instead, the value specified when creating the PAT will be used. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sentence clarity changes and providing a "workaround" for readers who want to adjust experation period.
Expiration in days can't be overwritten when regenerating a PAT. Instead, the value specified when creating the PAT will be used. | |
When regenerating a PAT, you cannot change the expiration period. The regenerated token will use the same expiration settings as the original token. To change expiration period, you must delete the PAT and create a new one. |
Content must go through a pre-merge checklist.
Pre-Merge Content Checklist
This documentation has been checked to ensure that:
title
,template
, anddate
are all settemplates/*.hbs
files) that points to a document.md
that is set to publish in the future? If so please only publish the.md
and.hbs
changes in real-time (otherwise there will be a menu item pointing to a.md
file that does not exist)cat -ve <filename> | grep $'\r' | wc -l
and expect 0 as a result)bart check
PREVIEW_MODE=1
and runnpm run styles
to update styling)npm run test
and resolved all errors