sirix icon indicating copy to clipboard operation
sirix copied to clipboard

Add documentation and/or tutorials

Open JohannesLichtenberger opened this issue 5 years ago ā€¢ 18 comments

If you give SirixDB a try, how about writing a tutorial and/or adding missing stuff to the documentation!?

JohannesLichtenberger avatar Oct 06 '19 19:10 JohannesLichtenberger

I would love to do this, Can you please let me know where do i find current documentation? Do we use any cms tools for the homepage.

vasanthkumar97 avatar Oct 09 '19 15:10 vasanthkumar97

https://sirix.org/documentation.html

Github is more or less our CMS ;-) I've added direct links to fork and edit content for a PR :+1:

JohannesLichtenberger avatar Oct 09 '19 15:10 JohannesLichtenberger

@vasanthkumar97 still interested? :)

JohannesLichtenberger avatar Oct 27 '19 17:10 JohannesLichtenberger

https://sirix.org/documentation.html

Github is more or less our CMS ;-) I've added direct links to fork and edit content for a PR šŸ‘

Cant reach this page? is this issue still open?

dextersrini avatar Dec 09 '19 10:12 dextersrini

Sure, and BTW: It's https://sirix.io/documentation.html, sorry :)

JohannesLichtenberger avatar Dec 09 '19 16:12 JohannesLichtenberger

Hi @JohannesLichtenberger is this issue still open to take? I am new to Open Source and would love to take up this issue as my first OS contribution. I would also be asking guidance if you don't mind as OS is still new to me.

KuhanPrakash avatar Mar 09 '21 16:03 KuhanPrakash

@KuhanPrakash, sure, it's still open :-)

JohannesLichtenberger avatar Mar 15 '21 14:03 JohannesLichtenberger

Hi @JohannesLichtenberger is this issue still open ? Iā€™m interested in the topic and would like to take the issue :)

adnanmorsy97 avatar Apr 14 '21 09:04 adnanmorsy97

Sure, that's awesome :)

JohannesLichtenberger avatar Apr 14 '21 10:04 JohannesLichtenberger

@JohannesLichtenberger Iā€™m happy to hear that. Can you please assign me to this issue. Thank you :)

adnanmorsy97 avatar Apr 14 '21 10:04 adnanmorsy97

can i work on this issue

Rishavgupta12345 avatar Sep 30 '21 06:09 Rishavgupta12345

Hey @JohannesLichtenberger I looked through the project and couldn't find anything, so I can contribute to:( Actually I am new to open source, can you help or suggest something which can I contribute to ? That's why I came to documentation part... If possible assign this issue to me and also suggest something.

Thanks In Advance

SUCHITRAGIRI avatar Oct 14 '21 18:10 SUCHITRAGIRI

You could for instance try to setup SirixDB with the Server: https://sirix.io/rest-api.html. One other aspect would be for instance to write an Open API docu file, which basically would be writing a Swagger Yaml file. That way we'd be able to auto-generate Client-SDKs and it would be an additional maybe even better documentation.

JohannesLichtenberger avatar Oct 14 '21 23:10 JohannesLichtenberger

BTW: We also have many clients in different languages and a frontend plus a query processor to work on: https://github.com/sirixdb

JohannesLichtenberger avatar Oct 14 '21 23:10 JohannesLichtenberger

@JohannesLichtenberger I am new to open source can you please assign this issue to me

gourcool avatar Nov 30 '21 05:11 gourcool

Hey @JohannesLichtenberger, I am a new budding contributor. Is there still scope for documentation improvement? If so, can you let me know how I can get to know šŸ˜….

Yashsomalkar avatar Oct 02 '22 18:10 Yashsomalkar

Ok thanks for assigning I am working on it .

Yashsomalkar avatar Oct 05 '22 06:10 Yashsomalkar

Hey @JohannesLichtenberger Can you assign this to me if there has been no progress by the person you assigned before?

Suhas2002 avatar Oct 12 '22 18:10 Suhas2002