Saleor: improve documentation's consistency and accuracy

[JavierOramas]

Im trying to deploy the project on my personal server, and it has been a bit frustrating.

you should include at least a note on the installation section including a link to the deployment section,
in the other hand i've had to look in the ver 2.9 documentation, beacuse the current one lacks some information present and way more explained in the older version
its agreat project, and im just trying to make it better for future users, thx and good work

[LeOndaz]

I think the whole documentation is a shame, no offense for them, but I can't even move myself there, the docker installation installs the local development version (why?) and some other frustrating things I've seen. The document says "node" is self explained when I hover over in graphql, however, I didn't understand it. It's just bad. I'm still trying to study it then I'll create my own guides later

[JavierOramas]

Agree, i found this https://youtu.be/zG7bZ2aPDko , im going to try it tonight, and will give feedback here

[karolkielecki]

@JavierOramas @LeOndaz Hey! Could you please provide more feedback on the docs and what is missing? Your suggestions will help improve them.

[sk1122]

@karolkielecki Documentation needs to be updated drastically. We can write a in-depth guide on Installation and also Deploying it on Heroku. Also in the Dashboard section, there is only a link to it, instead, we can have a Detailed Overview of What is there in Dasbhboard? We can also improve the Storefront Section to be more detailed. These changes can help beginners to understand Saleor easily & make cool stores with it.

[sk1122]

I'm interested in working on Documentation

[karolkielecki]

@sk1122 Thanks for your feedback and willingness to help us with the docs. Could you please tell us what exactly is missing? What would you like to write about installation? Recently, we have updated our docs about Heroku deployment: https://docs.saleor.io/docs/next/developer/running-saleor/heroku.

What do you mean by there is only a link to the dashboard section? You can find info about every section of the dashboard: https://docs.saleor.io/docs/dashboard/index

Currently, there is no storefront section, and I agree that we should start to work on it. For now, we have a readme section about modifying the storefront: https://github.com/mirumee/saleor-storefront#modifying-the-storefront

[sk1122]

@karolkielecki I was telling about Github Docs of Saleor. We could include small but important parts from docs.saleor.com to README.md. It will be helpful for developers or contributors to be on Github and not redirect to other sites for installation and we can also include a small overview of the dashboard.

[sk1122]

@karolkielecki In Installation Section, We can include How to Setup a Project with Saleor or How to configure Saleor. It will be a small tutorial but it will help developers with no experience of Saleor to Configure and use it without problem.

[karolkielecki]

In my opinion, the readme sections include the most important information. They shouldn't be too long. More details about installation and deployment and a general overview should be in actual documentation: https://docs.saleor.io/docs/. I agree about tutorials - after the upcoming releases, I hope we can start to work on it.

[sk1122]

@karolkielecki I am also very excited to work on this.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.