Skip to content
Permalink
Browse files

docs: Move contributing guidelines into docs (closes #194)

This commit moves the contributing guidelines into our documentation.
This helps give our contributing guidelines greater visibility to those
who want to get involved later.

Closes #194.

Signed-off-by: Justin W. Flory <git@jwf.io>
  • Loading branch information...
jwflory committed Nov 4, 2019
1 parent 962abbc commit a43ed2566b204a7edaa6db059d57bbfd1b61de72
Showing with 31 additions and 16 deletions.
  1. +1 −1 README.md
  2. +7 −7 .github/CONTRIBUTING.md → docs/dev/contributing.md
  3. +23 −8 docs/index.rst
@@ -30,7 +30,7 @@ Our developer community is found in these channels.

## Contribute to TeleIRC

See our [contributing guidelines](https://github.com/RITlug/teleirc/blob/master/.github/CONTRIBUTING.md).
See our [contributing guidelines](https://docs.teleirc.com/en/latest/dev/contributing/).


## Who uses TeleIRC?
@@ -1,16 +1,16 @@
Contributing to TeleIRC
Contributing guidelines
=======================

<!--
Style rule: one sentence per line please!
This makes git diffs easier to read.
-->

This is a guide on how to contribute to the TeleIRC project.
This guide explains how to contribute to the TeleIRC project.
It explicitly defines working practices of the development team.
The goal of this document is to help new contributors get up to speed with working on the project.
It is a living document and may change.
If you think something could be better, please [open an issue](https://github.com/RITlug/teleirc/issues/new) with your feedback.
This document helps new contributors get up to speed with working on the project.
It is a living document and will change.
If you think something could be better, please [open an issue](https://github.com/RITlug/teleirc/issues/new/choose) with your feedback.


## Table of contents
@@ -41,7 +41,7 @@ To set up a TeleIRC development environment, you need the following:
### Create Telegram bot

Create a Telegram bot using the Telegram [BotFather](https://t.me/botfather).
See [TeleIRC documentation](https://docs.teleirc.com/en/latest/quick-install/#create-a-telegram-bot) for more instructions on how to do this.
See [TeleIRC documentation](/quick-install) for more instructions on how to do this.

### Create Telegram group

@@ -60,7 +60,7 @@ See your IRC network's documentation on registering a channel.

Change the `env.example` file to `.env`.
Change the configuration values to the Telegram bot's tokens.
For more help with configuration, see the [TeleIRC documentation](https://docs.teleirc.com/en/latest/quick-install/#configure-and-run-teleirc).
For more help with configuration, see the [TeleIRC documentation](/quick-install).


## Open a new pull request
@@ -10,14 +10,29 @@ This bot was originally written for `RITlug <https://ritlug.com>`_.
Today, it is used by various communities.

.. toctree::
:maxdepth: 2
:caption: Contents

quick-install
deploy-teleirc
config-file-glossary
faq
who-uses-teleirc
:maxdepth: 2
:name: about
:caption: About TeleIRC:
:glob:

about/*

.. toctree::
:maxdepth: 2
:name: user
:caption: User documentation:

quick-install
deploy-teleirc
config-file-glossary

.. toctree::
:maxdepth: 2
:name: development
:caption: Developer documentation:
:glob:

dev/*


*********

0 comments on commit a43ed25

Please sign in to comment.
You can’t perform that action at this time.