From 56d4e6c639569a85636224e8463133916c8f4f12 Mon Sep 17 00:00:00 2001 From: Abdulhakim Ajetunmobi Date: Mon, 2 Dec 2024 16:35:45 +0000 Subject: [PATCH] update content + readme --- .github/workflows/workspace.yml | 1 + tutorials/messages_api-node-sms/README.md | 4 +++- .../src/content/docs/03-initialize-client.md | 5 +++-- .../messages_api-node-sms/src/content/docs/06-whats-next.md | 4 +++- tutorials/messages_api-node-sms/src/content/docs/index.mdx | 2 +- tutorials/messages_api-node-sms/tutorial-config.json | 2 +- 6 files changed, 12 insertions(+), 6 deletions(-) diff --git a/.github/workflows/workspace.yml b/.github/workflows/workspace.yml index 1cc584d..9e3d829 100644 --- a/.github/workflows/workspace.yml +++ b/.github/workflows/workspace.yml @@ -79,6 +79,7 @@ jobs: mkdir -p ws cd ws cp ../tutorial-config.json . + cp ../README.md . cp -r $GITHUB_WORKSPACE/scripting/TemplateWorkspace/. . cp $GITHUB_WORKSPACE/scripting/createWorkspace.sh . ls -a diff --git a/tutorials/messages_api-node-sms/README.md b/tutorials/messages_api-node-sms/README.md index fa9044e..897b833 100644 --- a/tutorials/messages_api-node-sms/README.md +++ b/tutorials/messages_api-node-sms/README.md @@ -1 +1,3 @@ -# Messages API Interactive Tutorial \ No newline at end of file +# Messages API Onboarding Tutorial - Send a SMS (Node.js) + +This tutorial takes you through how to send an SMS with the [Vonage Messages API](https://developer.vonage.com/messages/overview) in Node.js. \ No newline at end of file diff --git a/tutorials/messages_api-node-sms/src/content/docs/03-initialize-client.md b/tutorials/messages_api-node-sms/src/content/docs/03-initialize-client.md index 840023f..c3bb3fd 100644 --- a/tutorials/messages_api-node-sms/src/content/docs/03-initialize-client.md +++ b/tutorials/messages_api-node-sms/src/content/docs/03-initialize-client.md @@ -9,7 +9,7 @@ In this step, we will intialize the Vonage Client with some credentials and init | `VONAGE_NUMBER` | The phone number you are sending the message from. This is the number rented from Vonage when setting up the application. | | `TO_NUMBER` | The phone number you are sending the message to. | -> Note: If your account is in the trial period, the `TO_NUMBER` can only be the phone number that you used to create the account. Also, don't use a leading + or 00 when entering a phone number, start with the country code, for example 447700900000. +> Note: If your account is in the trial period, the `TO_NUMBER` can only be the phone number that you used to create the account. Also, don't use a leading + or 00 when entering a phone number, start with the country code, for example 447700900000. This is the E.164 number format. Copy this code into `send-sms.js` @@ -26,5 +26,6 @@ const vonage = new Vonage({ applicationId: process.env.VONAGE_APPLICATION_ID, privateKey: process.env.VONAGE_PRIVATE_KEY, }); - ``` + +Update `TO_NUMBER` with the number you want to send an SMS to. The environment variables that are being used have been auto populated for you, you can view them in the `.env` file. diff --git a/tutorials/messages_api-node-sms/src/content/docs/06-whats-next.md b/tutorials/messages_api-node-sms/src/content/docs/06-whats-next.md index fc2bc67..9f0d867 100644 --- a/tutorials/messages_api-node-sms/src/content/docs/06-whats-next.md +++ b/tutorials/messages_api-node-sms/src/content/docs/06-whats-next.md @@ -2,4 +2,6 @@ title: What's Next? --- -Please visit the Vonage Developer Portal for more tutorials. +Please visit the Vonage Developer Portal to learn more about the Vonage APIs. + +> Right click to open URLs in a new tab diff --git a/tutorials/messages_api-node-sms/src/content/docs/index.mdx b/tutorials/messages_api-node-sms/src/content/docs/index.mdx index f76a4e3..0e879a2 100644 --- a/tutorials/messages_api-node-sms/src/content/docs/index.mdx +++ b/tutorials/messages_api-node-sms/src/content/docs/index.mdx @@ -1,5 +1,5 @@ --- -title: Vonage Messages API Interactive Onboarding - SMS +title: Vonage Messages API Onboarding - SMS (Node.js) description: Get started building with the Vonage Messages API. template: splash hero: diff --git a/tutorials/messages_api-node-sms/tutorial-config.json b/tutorials/messages_api-node-sms/tutorial-config.json index 7efa361..a3d8f60 100644 --- a/tutorials/messages_api-node-sms/tutorial-config.json +++ b/tutorials/messages_api-node-sms/tutorial-config.json @@ -7,5 +7,5 @@ "panels": [ "terminal" ], - "version": "0.4.1" + "version": "0.5.0" } \ No newline at end of file