Skip to content

update documentation to include API Key Preview information#189

Merged
mattkim merged 3 commits intorelease/apikeysfrom
mattkim/apikey-readme
May 16, 2023
Merged

update documentation to include API Key Preview information#189
mattkim merged 3 commits intorelease/apikeysfrom
mattkim/apikey-readme

Conversation

@mattkim
Copy link
Copy Markdown
Member

@mattkim mattkim commented May 16, 2023

What was changed

update documentation to include API Key Preview information

Why?

to help users use API Keys

tminusplus
tminusplus previously approved these changes May 16, 2023
Copy link
Copy Markdown
Contributor

@tminusplus tminusplus left a comment

Choose a reason for hiding this comment

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

Two small comments otherwise LGTM :shipit:

Comment thread README.md Outdated
```

# API Key Management (Preview)
<em>The API Key feature is currently in "Preview Release". Customers must be invited to use this feature. Please reach out to Temporal Cloud support for more information.</em>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Alternatively _ or * is the markdown syntax, just happens to display fine in GitHub since it supports HTML tags.

Comment thread README.md

Create an API key by running the following command:
```
tcld apikey create --name <api-key-name> --description <api-key-description> --duration <api-key-duration>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We could mention the duration must be between 1 to 90 days.

@mattkim mattkim merged commit 065dbcd into release/apikeys May 16, 2023
@mattkim mattkim deleted the mattkim/apikey-readme branch May 16, 2023 21:33
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