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

feat(docs): Add plivo provider documentation #3293

Merged
merged 5 commits into from
Jun 14, 2023

Conversation

peoray
Copy link
Contributor

@peoray peoray commented Apr 26, 2023

What change does this PR introduce?

Add documentation for Plivo SMS provider

Why was this change needed?

Other information (Screenshots)

@github-actions github-actions bot added documentation Improvements or additions to documentation community labels Apr 26, 2023
@jainpawan21
Copy link
Member

@peoray
Can You please add step by step screenshot also.
Now onwards with each new provider docs, we are starting to add screenshot.

@peoray
Copy link
Contributor Author

peoray commented Apr 26, 2023

@jainpawan21 how do we intend to add images?
where will images be stored?

@scopsy
Copy link
Contributor

scopsy commented Apr 27, 2023

@peoray images are stored today at the /static folder for images. And served by docasaurus. Located in this folder: https://github.com/novuhq/novu/tree/next/docs/static/img

They can than be referenced with the /static path from the .md files

@peoray
Copy link
Contributor Author

peoray commented Apr 27, 2023

Thank you @scopsy
Do I create folders for each provider or just dump the images there?
Also, the step by step screenshot, does it include also getting the api key from the provider, or just adding it to Novu integration (usually the last part of the docs)

Pardon my many questions, since there's no similar example to follow, I'd like to be clear on what to do. I don't mind also working on current docs and adding the images where necessary once I understand what to do

@scopsy
Copy link
Contributor

scopsy commented Apr 27, 2023

@peoray really up to you :) You can create a folder for the provider, I agree that it will be easier to maintain on the long run.

@unicodeveloper
Copy link
Contributor

@peoray Do you still have plans to update this?

@peoray
Copy link
Contributor Author

peoray commented May 10, 2023

Yes @unicodeveloper

@peoray
Copy link
Contributor Author

peoray commented May 10, 2023

Although, I can't show images for adding the Account SID and Auth token from Plivo because it's not available in my region

@unicodeveloper
Copy link
Contributor

No problem. Can you update it with the ones available?

@peoray
Copy link
Contributor Author

peoray commented May 10, 2023

Sure, I'll update the PR today. Will ping you

@peoray
Copy link
Contributor Author

peoray commented May 11, 2023

@unicodeveloper please take a look

Copy link
Contributor

@p-fernandez p-fernandez left a comment

Choose a reason for hiding this comment

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

This looks good to me.
Just maybe even if not harmful next time split the PR in 2, one for each provider.
Thank you for your contribution.
🌟

@peoray
Copy link
Contributor Author

peoray commented Jun 14, 2023

What do you mean @p-fernandez

@p-fernandez
Copy link
Contributor

What do you mean @p-fernandez

To have splitted in 2 different PRs the Plivo and the Africa's Talking documentation additions. 🙂

@p-fernandez p-fernandez added this pull request to the merge queue Jun 14, 2023
Merged via the queue into novuhq:next with commit 986e0bb Jun 14, 2023
19 checks passed
@peoray
Copy link
Contributor Author

peoray commented Jun 14, 2023

@p-fernandez This is one PR, I just pulled the changes from AT cause it had the images folder setup since it was the first provider that I did with images and I didn't want to cause a conflict

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants