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

Documentation in step 7 is incorrect. #182

Closed
maclean-stu opened this issue Jul 19, 2018 · 2 comments
Closed

Documentation in step 7 is incorrect. #182

maclean-stu opened this issue Jul 19, 2018 · 2 comments

Comments

@maclean-stu
Copy link

The documentation instructions for authentication setup is misleading. The example shows IAM as being in the US South and Basic as being in the Sydney regions and as a consequence also confused the gateways. However, Basic is in US South and IAM is used in Sydney. This has caused some confusion for new Sydney based customers trialing the service sample.

I have updated the text below to correct the confusion.

Step 7.
Example .env file that configures the apikey and url for a Watson Assistant service instance hosted in the Sydney region:

ASSISTANT_IAM_APIKEY=X4rbi8vwZmKpXfowaS3GAsA7vdy17Qh7km5D6EzKLHL2
ASSISTANT_URL=https://gateway-syd.watsonplatform.net/assistant/api

If your service instance uses username and password credentials, add the ASSISTANT_USERNAME and ASSISTANT_PASSWORD variables to the .env file.

Example .env file that configures the username, password, and url for a Watson Assistant service instance hosted in the US South region:

ASSISTANT_USERNAME=522be-7b41-ab44-dec3-g1eab2ha73c6
ASSISTANT_PASSWORD=A4Z5BdGENrwu8
ASSISTANT_URL=https://gateway.watsonplatform.net/assistant/api

Add the WORKSPACE_ID to the previous properties
WORKSPACE_ID=522be-7b41-ab44-dec3-g1eab2ha73c6

@watson-github-bot
Copy link
Member

🎉 This issue has been resolved in version 1.0.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

@Oliver-I
Copy link
Contributor

@stevenpkg FYI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants