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

Install.rst: Add link for the Docker documentation #590

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rohanrajpal
Copy link

@rohanrajpal rohanrajpal commented Jan 9, 2019

Adds the link for the Coala Docker documentation giving
users more information on how to use Coala with Docker.

Closes #588

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

  • I read the commit guidelines and I've followed
    them.
  • I ran coala over my code locally. (All commits have to pass
    individually.
    It is not sufficient to have "fixup commits" on your PR,
    our bot will still report the issues for the previous commit.) You will
    likely receive a lot of bot comments and build failures if coala does not
    pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

Copy link
Member

@budukhyash budukhyash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍 Great work for a first PR !!

Users/Install.rst Outdated Show resolved Hide resolved
@rohanrajpal rohanrajpal force-pushed the my-first-good-pull-request branch from 99328c5 to 8a08b44 Compare January 10, 2019 12:48
Copy link
Member

@li-boxuan li-boxuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check your commit message, coala is always written with a small 'c' 😉

Users/Install.rst Outdated Show resolved Hide resolved
@rohanrajpal
Copy link
Author

@budukhyash thanks for reviewing!
@shashank-b @li-boxuan I've resolved the issues, can you both review it again?

@rohanrajpal
Copy link
Author

@shashank-b thanks for approving. Who else needs to accept this PR so that it gets merged?

@shashank-b
Copy link
Member

Once one of the maintainers approve it, you can start working on other issues, and the maintainers would merge it when appropriate.

Copy link
Member

@utkarsh2102 utkarsh2102 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

Users/Install.rst Outdated Show resolved Hide resolved
Adds the link for the coala Docker documentation giving
users more information on how to use coala with Docker.

Closes coala#588
@@ -184,6 +184,9 @@ virtualenv with:
Using coala With Docker
=======================

Don't know what Docker is? Have a look at
`What is Docker? <Docker_Image.html>`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use just <Docker_Image> - sphinx will automatically add the .html

Copy link
Author

@rohanrajpal rohanrajpal Feb 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did that but I'm getting ERR_FILE_NOT_FOUND when I click on the link. I'm using Sphinx v1.6.5

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically it's not automatically adding the HTML for me.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jayvdb any suggestions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Improvement in the Installation guide ( Docker Part )
8 participants