[SockoBot] Write an updated README.md file & a deploy tutorial for a Discord Steem bot.

in utopian-io •  7 years ago  (edited)

sockobotwide.jpg

SockoBot is trying to be the only tool you'll ever need on your Discord Server or Facebook Page when it comes to steem, while also being easily expandable to anyone that knows a bit of Python.

SockoBot

Details

This task request asks for a tech writer to write 2 important documents for the Python Discord bot. Namely:

  • An updated README.md file following professional standards (the format can be altered, the current format is very WIP)
  • A full tutorial (excluding the installing of Python libraries) on how to setup and deploy SockoBot to a server, as well as guide on how to start using it. This tutorial has to be submitted in a HOW_TO_DEPLOY.md markdown file and has to have a consistent, professional format.

While writing this, I will guide you through the functionalities of the bot and teach you how to deploy it on your own machine. I expect of you to have basic skills with using open-source software, programming/Python knowledge is very welcome.

Components

The components that will be affected are:

  • The README.md file, which is very outdated (doesn't even have most commands in it!), will be updated and get a new, better format.

image.png

  • The HOW_TO_DEPLOY.md file that doesn't exist yet will be created.

Deadline

The tasks must be completed in the following 3 weeks after this Task Request is published.

  • The Deadline is 05.03.2018

Communication

You can contact me by replying to this post, or contacting me immediately at Jestemkioskiem#5566 on Discord. Make sure you tell me why you've contacted me in your first message, as I get a huge amount of spam as a Supervisor every day.

Rules

  • The documents need to be submitted via a Pull Request to this repository.
  • The documents need to be professional, although typos and small grammatical errors are acceptable as I'll review the language used and correct them.
  • The documents have to use markdown or reStructuredText for formatting.
  • Alternatively, the HOW_TO_DEPLOY.md file can be submitted on Github Wiki.



Posted on Utopian.io - Rewarding Open Source Contributors

Authors get paid when people like you upvote their post.
If you enjoyed what you read here, create your account today and start earning FREE STEEM!
Sort Order:  

I actually like writing documentation and creating tutorials, so I'm definitely up for it! Can it also be written in reStructuredText or does it have to be Markdown?

Does Github support reStructuredText? If so, sure!

Hey @jestemkioskiem I am @utopian-io. I have just upvoted you!

Achievements

  • You have less than 500 followers. Just gave you a gift to help you succeed!
  • Seems like you contribute quite often. AMAZING!

Suggestions

  • Contribute more often to get higher and higher rewards. I wish to see you often!
  • Work on your followers to increase the votes/rewards. I follow what humans do and my vote is mainly based on that. Good luck!

Get Noticed!

  • Did you know project owners can manually vote with their own voting power or by voting power delegated to their projects? Ask the project owner to review your contributions!

Community-Driven Witness!

I am the first and only Steem Community-Driven Witness. Participate on Discord. Lets GROW TOGETHER!

mooncryption-utopian-witness-gif

Up-vote this comment to grow my power and help Open Source contributions like this one. Want to chat? Join me on Discord https://discord.gg/Pc8HG9x

Thank you for the contribution. It has been approved.

You can contact us on Discord.
[utopian-moderator]