Update the documentation

[pypingou]

With the addition of the candidate upload and moderation the documentation needs to be adjusted, most likely the administrate and usage parts.

[ghost]

I'll look into this. Once I've had a chance to sit down and go through this app again I'll make notes of what I think needs to be added / adjusted and we can hopefully get this knocked out relatively quickly.

[pypingou]

Great, thanks! :)

[ghost]

I made some initial changes to the administrate.rst and usage.rst files. What I have now may be enough to satisfy the requirement for this fix but I think we can make additional changes to the documentation to make it better overall. Do we want to make large scale changes to the documentation or do we just want to make minor updates that are directly related to this item?

[pypingou]

Do we want to make large scale changes to the documentation or do we just want to make minor updates that are directly related to this item?

It basically depends on what you mean with large scale changes :)

So I would say, let's make the updates the current documentation as it is, and then look at the large scale one so that if we disagree, at least the current documentation is up to date :)

What do you think?

[ghost]

"Large scale changes" was a bit dramatic on my part. :) I simply mean making changes to the whole file to word things a little differently so it's easier to read and follow. Fix spelling / grammar issues. Things of that sort.

If you look at my copy of the project you can see the changes I've already made. If they are OK I'll submit a pull request and we can finish this off and we can come back later if we need to update them further. Just let me know.

[pypingou]

I'll check it out, thanks for working on this, it's much appreciated :)

[pypingou]

Couple of comments but otherwise it looks quite good to me :)

The only thing is if you could either merge the commits together or give them different commit messages it would look nicer, but otherwise I can do it before merging in master :)

[ghost]

Can you go ahead and make the change when you merge? I'm not sure how to update the commit messages since I made the changes using the web UI and not from CLI. I've found a couple of possible ways around this but I'm really not comfortable with them as they all reference potential issues.

[pypingou]

Sure I can do that, thanks for working on this!

If you want to learn more about git, I'm also open to work you through the process, I think irc (on #fedora-apps) would be the most convenient place for this if you are interested :)

[pypingou]

As you can see I (finally) merged your changes into two commits :)

Thanks a lot for working on this, it is most useful :)