search

novuhq / novu-ruby

Ruby SDK for Novu - The open-source notification infrastructure for engineers. 🚀
https://rubygems.org/gems/novu
MIT License
24 stars 10 forks source link

Docs: Quickstart Guide on Getting Started with Novu Ruby #27

Closed unicodeveloper closed 1 year ago

unicodeveloper commented 1 year ago

We currently have quickstart guides in different languages.

We need a Ruby Quickstart. There's a template to follow below:

Get Started with PHP

unicodeveloper commented 1 year ago

@amansaini0003 Is this something you will like to work on? 👀 Opening it up to the community but wanted to see if it's something you'll want first dibs on 😄

Eazybright commented 1 year ago

@unicodeveloper can i take this one?

unicodeveloper commented 1 year ago

Yes please, you can. Assigning this issue to you now @Eazybright

unicodeveloper commented 1 year ago

Please let me know if you need any help. This is how to get the docs up and running locally.

Eazybright commented 1 year ago

Alright.

Thanks

Eazybright commented 1 year ago
Screenshot 2023-07-06 at 11 39 07 PM

@unicodeveloper can you please help with fixing this lint errors? I'm trying to make a commit to make a PR

unicodeveloper commented 1 year ago

I am seeing “unclosed string” in the get started with Ruby file. Can you check the markdown file to be sure something isn’t off there?

On Thu, Jul 6, 2023 at 11:40 PM Kolawole Ezekiel @.***> wrote:

[image: Screenshot 2023-07-06 at 11 39 07 PM] https://user-images.githubusercontent.com/30163347/251589991-1513b4d7-fe9c-40b5-8f59-f9a995a3a4fe.png @unicodeveloper https://github.com/unicodeveloper can you please help with fixing this lint errors? I'm trying to make a commit to make a PR

— Reply to this email directly, view it on GitHub https://github.com/novuhq/novu-ruby/issues/27#issuecomment-1624397068, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAWPNUN76INPCUYQQ4EQLYTXO45FNANCNFSM6AAAAAAZ42QRYA . You are receiving this because you were mentioned.Message ID: @.***>

-- Best Regards,

Prosper Otemuyiwa Co-founder, Eden @unicodeveloper https://twitter.com/unicodeveloper | prosper.otemuyiwa1 ( Skype )

Eazybright commented 1 year ago

I've checked again, there's no open string

unicodeveloper commented 1 year ago

Before you added the ruby quickstart, did you encounter any error while running the docs locally?

Eazybright commented 1 year ago

no

unicodeveloper commented 1 year ago

One way to know where the error is coming from is to delete everything you have in the getting started ruby file and start adding them back paragraph by paragraph.

Run the docs for each paragraph you add to know where the error is coming from.

Another question for you: Does it give error when you run it locally with the getting started ruby file or does the lint error only happen when you want to commit?

Eazybright commented 1 year ago

Okay i will try to add them paragraph by paragraph.

i saw an error on the console

Screenshot 2023-07-07 at 12 07 07 AM
unicodeveloper commented 1 year ago

Module not found. So for some reasons it can’t find that file, you need to check how you added that file again and run it again.

On Fri, Jul 7, 2023 at 12:08 AM Kolawole Ezekiel @.***> wrote:

Okay i will try to add them paragraph by paragraph.

i saw an error on the console [image: Screenshot 2023-07-07 at 12 07 07 AM] https://user-images.githubusercontent.com/30163347/251594346-5b01e0b0-00fd-4697-84c3-e3a02ae55749.png

— Reply to this email directly, view it on GitHub https://github.com/novuhq/novu-ruby/issues/27#issuecomment-1624416507, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAWPNUIYOZBTG7PMRHE4OG3XO5AOPANCNFSM6AAAAAAZ42QRYA . You are receiving this because you were mentioned.Message ID: @.***>

-- Best Regards,

Prosper Otemuyiwa Co-founder, Eden @unicodeveloper https://twitter.com/unicodeveloper | prosper.otemuyiwa1 ( Skype )

Eazybright commented 1 year ago

Ops! Is there a specific way to add the file?

I just created the file casually.

unicodeveloper commented 1 year ago

Check the other QuickStart files to be sure it follows the pattern they follow.

On Fri, Jul 7, 2023 at 12:17 AM Kolawole Ezekiel @.***> wrote:

Ops! Is there a specific way to add the file?

I just created the file casually.

— Reply to this email directly, view it on GitHub https://github.com/novuhq/novu-ruby/issues/27#issuecomment-1624422552, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAWPNUOR7ZQP2TOTNYFGUADXO5BRVANCNFSM6AAAAAAZ42QRYA . You are receiving this because you were mentioned.Message ID: @.***>

-- Best Regards,

Prosper Otemuyiwa Co-founder, Eden @unicodeveloper https://twitter.com/unicodeveloper | prosper.otemuyiwa1 ( Skype )

Eazybright commented 1 year ago

Issue resolved.

It was a linting + vscode problem.

unicodeveloper commented 1 year ago

That’s great news

On Fri, Jul 7, 2023 at 12:33 AM Kolawole Ezekiel @.***> wrote:

Issue resolved.

It was a linting + vscode problem.

— Reply to this email directly, view it on GitHub https://github.com/novuhq/novu-ruby/issues/27#issuecomment-1624432634, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAWPNULDS5AKPJU2I5BDP2DXO5DLTANCNFSM6AAAAAAZ42QRYA . You are receiving this because you were mentioned.Message ID: @.***>

-- Best Regards,

Prosper Otemuyiwa Co-founder, Eden @unicodeveloper https://twitter.com/unicodeveloper | prosper.otemuyiwa1 ( Skype )

Eazybright commented 1 year ago

PR raised: https://github.com/novuhq/novu/pull/3738

unicodeveloper commented 1 year ago

Thanks @Eazybright . Will check it out today

unicodeveloper commented 1 year ago

@Eazybright Please one more thing. Can you resubmit the PR against the main branch?

Eazybright commented 1 year ago

done

https://github.com/novuhq/novu/pull/3739

unicodeveloper commented 1 year ago

Dropped a comment on the PR @Eazybright

Eazybright commented 1 year ago

@unicodeveloper new PR raised. https://github.com/novuhq/novu/pull/3742

unicodeveloper commented 1 year ago

Hey @Eazybright there's a part that needs to be checked again the quickstart guide you wrote.

This part:

datafield datafield2

In PHP, the metadata has to be an array. In Ruby, what will be the equivalent?

Eazybright commented 1 year ago

It should be object of metadata.

unicodeveloper commented 1 year ago

I guessed as much. Please can you submit a PR to correct it? 🙏

On Sun, Jul 9, 2023 at 7:30 PM Kolawole Ezekiel @.***> wrote:

It should be object of metadata.

— Reply to this email directly, view it on GitHub https://github.com/novuhq/novu-ruby/issues/27#issuecomment-1627790671, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAWPNUPK2OH2MFJSN6JQ5BTXPL2DPANCNFSM6AAAAAAZ42QRYA . You are receiving this because you were mentioned.Message ID: @.***>

-- Best Regards,

Prosper Otemuyiwa Co-founder, Eden @unicodeveloper https://twitter.com/unicodeveloper | prosper.otemuyiwa1 ( Skype )

Eazybright commented 1 year ago

PR submitted. https://github.com/novuhq/novu/pull/3751

unicodeveloper commented 1 year ago

Issue resolved.

It was a linting + vscode problem.

Please how did you resolve this issue? I just got someone else experiencing the same issue. @Eazybright

Eazybright commented 1 year ago

add "--no-verify" argument to the git commit command.

On Mon, Jul 10, 2023 at 9:39 PM Prosper Otemuyiwa @.***> wrote:

Issue resolved.

It was a linting + vscode problem.

Please how did you resolve this issue? I just got someone else experiencing the same issue.

— Reply to this email directly, view it on GitHub https://github.com/novuhq/novu-ruby/issues/27#issuecomment-1629698385, or unsubscribe https://github.com/notifications/unsubscribe-auth/AHGEDE7BRNGI5F7X4OBU6FDXPRSBFANCNFSM6AAAAAAZ42QRYA . You are receiving this because you were mentioned.Message ID: @.***>