Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation around contributing and workflow #217

Merged
merged 5 commits into from Nov 4, 2019

Conversation

@jwflory
Copy link
Member

jwflory commented Nov 4, 2019

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:

  • docs: Move contributing guidelines into docs (closes #194)1e64881
  • docs: Move FAQ/who uses pages into their own category227fa05
  • docs: Add recommonmark as docs dependencye1be5ab
  • docs: Add placeholder file to _static1a1d4f5
  • docs: Add placeholder CONTRIBUTING.md filecdf11a5
jwflory added 5 commits Nov 4, 2019
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>
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 jwflory requested a review from RITlug/teleirc-developers-commit-access Nov 4, 2019
@jwflory jwflory added this to In progress in TeleIRC development via automation Nov 4, 2019
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
Tjzabel approved these changes Nov 4, 2019
Copy link
Member

Tjzabel left a comment

Looks good to me! Thanks for doing this 👍

### 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.

This comment has been minimized.

Copy link
@Tjzabel

Tjzabel Nov 4, 2019

Member

Huh, I'm not familiar with this syntax! I'll assume you tested that the link works :P

@jwflory jwflory merged commit b66e357 into RITlug:master Nov 4, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
TeleIRC development automation moved this from In progress to Done Nov 4, 2019
@jwflory jwflory deleted the jwflory:194/docs-merge-workflow branch Nov 4, 2019
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
Projects
3 participants
You can’t perform that action at this time.