Jandig: improve the "how to publish content" manual

@discombobulateme can you please have a look at this documentation and suggest some improvements?

It's related to the actual documentation.

On Mon, 21 Sep 2020 at 21:54, Matheus Salles Blanco <
[email protected]> wrote:

Is this issue related to the actual manual documentation? Or to a
in-application tutorial of how to publish that should be improved?

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/memeLab/Jandig/issues/244#issuecomment-696457035, or
unsubscribe
https://github.com/notifications/unsubscribe-auth/AAH4ULG6BN72GEWAOFVYY33SG7YT7ANCNFSM4I5SVXAA
.

--
Angelo Pixel
https://www.linkedin.com/in/vjpixel/

It's related to the actual documentation.
…
On Mon, 21 Sep 2020 at 21:54, Matheus Salles Blanco < @.*> wrote: Is this issue related to the actual manual documentation? Or to a in-application tutorial of how to publish that should be improved? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#244 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAH4ULG6BN72GEWAOFVYY33SG7YT7ANCNFSM4I5SVXAA .
-- Angelo Pixel https://www.linkedin.com/in/vjpixel/

Got it! Thank you very much!

If you need any more help, ping me.

Hi, I wanted to check up on some doubts regarding this documentation.

First is about its language. We wrote this manual in english and would like to know whether it is ok or if portuguese would be more appropriate for the viewing users.

Secondly is about the document viewing framework. I believe Jandig is using Sphynx to compile and display its documentation, correct? When I ran the local build on my computer, DJANGO threw an error regarding the index.html file when I tried to access the "Help" page. This happened both on the develop branch and on the branch created for this specific issue.

Here's a screenshot of the error shown in the browser:

And when I tried to look it up on the code, there was an error on the index.rst file, inside the docs folder:

Is this an expected error? Does it require a specific configuration in order for me to access the help page?

Hi Matheus,

I see that you wrote the manual in English. It's amazing because we want to attract more international users.

But the majority of our users are Portuguese speaking, so it's good to keep both versions.

Do you think it's possible to translate the new version to Portuguese, so we have both?

@pablodiegoss can answer about Sphynx better than me.

Hi Matheus,

I see that you wrote the manual in English. It's amazing because we want to attract more international users.

But the majority of our users are Portuguese speaking, so it's good to keep both versions.

Do you think it's possible to translate the new version to Portuguese, so we have both?

@pablodiegoss can answer about Sphynx better than me.

Yes, of course. I will leave the Pull Request with the WIP tag for the time being so that I can translate it.

It's done! I have changed the tag to REVIEW.

Secondly is about the document viewing framework. I believe Jandig is using Sphynx to compile and display its documentation, correct? When I ran the local build on my computer, DJANGO threw an error regarding the index.html file when I tried to access the "Help" page. This happened both on the develop branch and on the branch created for this specific issue.

Here's a screenshot of the error shown in the browser:

Your comment is right, we use .rst files to describe our docs and Sphinx to generate html files from them, which django-docs routes and make them linkable through "/docs".

Awesome that you noticed that error, we moved around some folders on some update and now Sphinx wasn't being able to find the index.html that it generated previously. I've found the problem and pushed a fix to the develop branch, can you verify if the error still happens after pulling this commit?

And when I tried to look it up on the code, there was an error on the index.rst file, inside the docs folder:

Is this an expected error? Does it require a specific configuration in order for me to access the help page?

This seems to be just an error from your editor that isn't being able to recognize the RST syntax... it seems that you are using VScode, right?
I'm using the reStructuredText extension to get syntax highlighting and suggestions for rst, maybe installing some extension fixes your problem

Awesome that you noticed that error, we moved around some folders on some update and now Sphinx wasn't being able to find the index.html that it generated previously. I've found the problem and pushed a fix to the develop branch, can you verify if the error still happens after pulling this commit?

@pablodiegoss I tested here in our branch and your last commit fixed the problem 😄

Sorry for the delay. I've just commented on #330 .

Hello! Since this PR was already merged, could this issue be closed?

Yep!