search

jupyter-naas / naas

Low-code Python library to safely use notebooks in production: schedule workflows, generate assets, trigger webhooks, send notifications, build pipelines, manage secrets (Cloud-only)
https://app.naas.ai/
GNU Affero General Public License v3.0
286 stars 25 forks source link

feat: improve Naas readme #78

Closed jravenel closed 2 years ago

jravenel commented 3 years ago

Community support Contributing guide Features Quick start Mission

Inspired by https://github.com/airbytehq/airbyte/

Dr0p42 commented 3 years ago

Is this issue related to this commit ? https://github.com/jupyter-naas/naas/commit/7a7570784b2393512e6d8d68babdbc6746519a64

@jravenel

shloka-gupta commented 2 years ago

Hello, @jravenel here's rough work. https://hackmd.io/@9w-awoLYS8-TWvM6lvxy1A/SkX2504ec

I have added a few things. A suggestion-- Can the Installation be put in an 'Installation guide' document and linked? This may make the ReadMe a little light in weight. Too much information can be overwhelming.

jravenel commented 2 years ago

Hey @chicken-biryani yes that's a good idea. I really like your proposal. Let's work in a PR to fine tune?

shloka-gupta commented 2 years ago

@jravenel is it okay if I edit it a little more. Come up with a proper draft and then create a PR?

jravenel commented 2 years ago

Of course! Let's do this @chicken-biryani

jravenel commented 2 years ago

Hey @chicken-biryani let me know if I can help to move forward on this :)

shloka-gupta commented 2 years ago

@jravenel we're taking inspiration from airbyte itself, right? Any other suggested places?

I was thinking of improving the conplete readme and then creating a PR instead of one by one.

Is that a good idea?

jravenel commented 2 years ago

@jravenel we're taking inspiration from airbyte itself, right? Any other suggested places?

I was thinking of improving the conplete readme and then creating a PR instead of one by one.

Is that a good idea?

Not sure @chicken-biryani , it's always better to split in small chunks to see progress IMHO. Otherwise it's hard to review. Yes airbyte is the source of inspiration :)

Dr0p42 commented 2 years ago

Hello @chicken-biryani, were you able to make progress on this issue?

shloka-gupta commented 2 years ago

Hello @Dr0p42 I haven't. And won't be able to for a while I believe. As college has been taking up a lot of time a leaving ilttle to no room for voulenteer work.

Dr0p42 commented 2 years ago

Hello @Dr0p42 I haven't. And won't be able to for a while I believe. As college has been taking up a lot of time a leaving ilttle to no room for voulenteer work.

Ok no worries @chicken-biryani, thank you for letting us know. I will move this issue in the backlog for now.