diff --git a/docs/Contribution Guide.md b/docs/Contribution Guide.md index 3dff9b35..ca0cd94f 100644 --- a/docs/Contribution Guide.md +++ b/docs/Contribution Guide.md @@ -1,6 +1,6 @@ ### How to contribute -1. Make Pull Requests to the [**dev BRANCH**](https://github.com/Kwoth/NadekoBot/tree/dev). +1. Make Pull Requests to the [**1.9 BRANCH**](https://github.com/Kwoth/NadekoBot/tree/1.9). 2. Keep 1 Pull Request to a single feature. 3. Explain what you did in the PR message. diff --git a/docs/guides/Docker Guide.md b/docs/guides/Docker Guide.md index e249cbff..5c50e73d 100644 --- a/docs/guides/Docker Guide.md +++ b/docs/guides/Docker Guide.md @@ -1,5 +1,5 @@ # NadekoBot a Discord bot -Nadeko is written in C# and Discord.net for more information visit +Nadeko is written in C# and Discord.Net for more information visit ## Install Docker Follow the respective guide for your operating system found here [Docker Engine Install Guide](https://docs.docker.com/engine/installation/) @@ -14,14 +14,12 @@ docker create --name=nadeko -v /nadeko/conf/:/root/nadeko -v /nadeko/data:/opt/N -If you are making a fresh install, create your credentials.json from the following guide and place it in the /nadeko folder [Nadeko JSON Guide](http://nadekobot.readthedocs.io/en/latest/JSON%20Explanations/) -Next start the docker up with - -`docker start nadeko; docker logs -f nadeko` +Next start the docker up with `docker start nadeko; docker logs -f nadeko` The docker will start and the log file will start scrolling past. Depending on hardware the bot start can take up to 5 minutes on a small DigitalOcean droplet. Once the log ends with "NadekoBot | Starting NadekoBot v1.0-rc2" the bot is ready and can be invited to your server. Ctrl+C at this point to stop viewing the logs. -After a few moments you should be able to invite Nadeko to your server. If you cannot check the log file for errors. +After a few moments you should be able to invite Nadeko to your server. If you cannot, check the log file for errors. ## Monitoring @@ -45,16 +43,16 @@ docker create --name=nadeko -v /nadeko/conf/:/root/nadeko -v /nadeko/data:/opt/N # Automatic Updates -Automatic update are now handled by watchertower [WatchTower GitHub](https://github.com/CenturyLinkLabs/watchtower) -To setup watchtower to keep Nadeko up-to-date for you with the default settings use the following command +Automatic update are now handled by WatchTower [WatchTower GitHub](https://github.com/CenturyLinkLabs/watchtower) +To setup WatchTower to keep Nadeko up-to-date for you with the default settings, use the following command ```bash docker run -d --name watchtower -v /var/run/docker.sock:/var/run/docker.sock centurylink/watchtower --cleanup nadeko ``` -This will check for updates to the docker every 5 minutes and update immediately. Alternatively using the `--interval X` command to change the interval, where X is the amount of time in seconds to wait. eg 21600 for 6 hours. +This will check for updates to the docker every 5 minutes and update immediately. Alternatively using the `--interval X` command to change the interval, where X is the amount of time in seconds to wait. e.g 21600 for 6 hours. -If you have any issues with the docker setup, please ask in #help but indicate you are using the docker. +If you have any issues with the docker setup, please ask in #help channel on our [Discord server](https://discordapp.com/invite/nadekobot) but indicate you are using the docker. -For information about configuring your bot or its functionality, please check the guides. +For information about configuring your bot or its functionality, please check the [documentation](http://nadekobot.readthedocs.io/en/latest).