Improve documentation around contributing and workflow #217
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 RITlug#194. Signed-off-by: Justin W. Flory <git@jwf.io>
This commit creates a new "About" category in our docs. This category is intended to hold content that is not deeply technical and explains more about our project. I anticipate this category growing over time. Signed-off-by: Justin W. Flory <git@jwf.io>
The Markdown support did not actually work until this was installed as a dependency. This commit makes sure it is tracked in our Pipfile dependencies. Signed-off-by: Justin W. Flory <git@jwf.io>
This is a fix to resolve a warning that Sphinx will always complain about if the _static directory is missing. Signed-off-by: Justin W. Flory <git@jwf.io>
This file is a pointer to the actual hosted URL of our contributing guidelines. They are now published alongside our documentation. Signed-off-by: Justin W. Flory <git@jwf.io>
jwflory
added
documentation
jwflory
added a commit
to jwflory/teleirc
that referenced
this pull request
Nov 4, 2019
This commit switches our Travis CI builds over to a matrix build system. In addition to performing the standard unit test suite for NodeJS, it will also kick up a VM to build and test our docs. This is a fairly lightweight way to guarantee that our docs are building. Also, you will notice this commit is failing! That is expected. The `recommonmark` dependency was not added in RITlug#215, but it was added in PR RITlug#217. Once that PR merges, this CI test will pass again. Signed-off-by: Justin W. Flory <git@jwf.io>
Tjzabel
approved these changes
Nov 4, 2019
| ### Create Telegram bot | ||
|
|
||
| Create a Telegram bot using the Telegram [BotFather](https://t.me/botfather). | ||
| See [TeleIRC documentation](/quick-install) for more instructions on how to do this. |
There was a problem hiding this comment.
Huh, I'm not familiar with this syntax! I'll assume you tested that the link works :P
jwflory
added a commit
to jwflory/teleirc
that referenced
this pull request
Nov 4, 2019
This commit switches our Travis CI builds over to a matrix build system. In addition to performing the standard unit test suite for NodeJS, it will also kick up a VM to build and test our docs. This is a fairly lightweight way to guarantee that our docs are building. Also, you will notice this commit is failing! That is expected. The `recommonmark` dependency was not added in RITlug#215, but it was added in PR RITlug#217. Once that PR merges, this CI test will pass again. Signed-off-by: Justin W. Flory <git@jwf.io>
jwflory
added a commit
that referenced
this pull request
Nov 4, 2019
This commit switches our Travis CI builds over to a matrix build system. In addition to performing the standard unit test suite for NodeJS, it will also kick up a VM to build and test our docs. This is a fairly lightweight way to guarantee that our docs are building. Also, you will notice this commit is failing! That is expected. The `recommonmark` dependency was not added in #215, but it was added in PR #217. Once that PR merges, this CI test will pass again. Signed-off-by: Justin W. Flory <git@jwf.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is opened to address feedback and discussion in #194. It includes a collection of improvements and reorganizations of information in the new docs format. To summarize, here are the commit messages: