Fixing and enhancing documentation

[JohannesLichtenberger]

Fixing typos and/or grammar, mark unclear sections.

Maybe if you try out SirixDB you could even add a sentence, a section or even write a tutorial or a blog post if yoh like it :-)

[elizabethqiu]

Can I help with this?

[JohannesLichtenberger]

Sure, would be great :)

[JohannesLichtenberger]

Let me know if you need help :+1:

[elizabethqiu]

Thank you! I would love receive a bit more clarification on how to get started. (I have basic coding skills, but am not confident on overall skills)

[JohannesLichtenberger]

hi @elizabethqiu, that's great. You can for instance try to get the web GUI up-and-running and work on the documentation.

You can also try to run the (mostly) Java based, or Kotlin based unit/integration tests in IntelliJ. Or you might try to use the Python-Client for instance.

[JohannesLichtenberger]

I hope this helps :)

[adnanmorsy97]

Hi @JohannesLichtenberger is this issue still open ?

[JohannesLichtenberger]

Yes, still open

[adnanmorsy97]

@JohannesLichtenberger Perfekt! Can you please assign me to this issue. Thank you :)

[adnanmorsy97]

Hey @JohannesLichtenberger, I have read your documentary and found some spelling and grammar mistakes. I have already forked your project and would like to know what my next steps should be. I have noticed, that there is a link in the documentary where I can do some changes in the documentary. Should I use this link ? Do I need to create a new branch for this issue ?

[mosheduminer]

@adnanmorsy97 unless you have permissions to the repository, you would not be able to make changes without forking and creating a PR. That being so, I don't believe that you would be able to commit changes using that link. It simply takes you to an editing page, and it will probably create a fork for you when you wish to save your changes.

[adnanmorsy97]

@mosheduminer thanks for your answer. That means, that I should use the link and after I did some changes in the documentary, I should create a PR ?

[mosheduminer]

Honestly, I'm not sure exactly how the link works. I assume that if you try to save changes through that link, it will automatically show you a page to create a PR. So if you want to, sure, use the link.

[JohannesLichtenberger]

Yes, I believe what @mosheduminer wrote is true :-)

[adnanmorsy97]

Hey @JohannesLichtenberger, I have read the entire documentation and fixed all the mistakes, that I have found. I also made a PR. You can find my work in the following links:

1. https://github.com/sirixdb/sirixdb.github.io/pull/14

2. https://github.com/sirixdb/sirixdb.github.io/pull/16

3. https://github.com/sirixdb/sirixdb.github.io/pull/17

4. https://github.com/sirixdb/sirixdb.github.io/pull/18

5. https://github.com/sirixdb/sirixdb.github.io/pull/19

Could you please merge them ? I would be very happy if you did that.

However, I have noticed some grammar and spelling mistakes in the “DOM ALIKE” and “PYTHON SDK API” documentary, but I can’t find a link for these two! What should I do ? Is there another way to make changes in the documentation instead of using the link or could you perhaps add the link for these two ?

I hope you liked my work and would like to know if you have any further suggestions or improvements for me ? 😊

[Rishavgupta12345]

can i work on this issue

[Sanket-777]

is this issue still open

[JohannesLichtenberger]

sure, it's still open :)