Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

[CI] Fix links in contribute.rst #752

Merged
merged 3 commits into from Jun 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/jenkins/build_steps.groovy
Expand Up @@ -117,7 +117,6 @@ def website_linkcheck(workspace_name, conda_env_name) {
if [[ ${enforce_linkcheck} == true ]]; then
make -C docs linkcheck SPHINXOPTS=-W
else
set +e
make -C docs linkcheck
fi;
set +ex
Expand Down
11 changes: 8 additions & 3 deletions docs/community/contribute.rst
Expand Up @@ -41,10 +41,15 @@ Make changes
------------

Our package uses continuous integration and code coverage tools for verifying pull requests. Before
submitting, contributor should perform the following checks:
submitting, contributor should ensure that the following checks do not fail:

- `Lint (code style) check <https://github.com/dmlc/gluon-nlp/blob/master/Jenkinsfile#L5>`__.
- `Py2 <https://github.com/dmlc/gluon-nlp/blob/master/Jenkinsfile#L18>`__ and `Py3 <https://github.com/dmlc/gluon-nlp/blob/master/Jenkinsfile#L28>`__ tests.
- Lint (code style)
- Unittest (running under Python 2 and Python 3)
- Doctest (running under Python 2 and Python 3)

The commands executed by the continuous integration server to perform the tests
are listed in the `build_steps.groovy file
<https://github.com/dmlc/gluon-nlp/blob/master/ci/jenkins/build_steps.groovy>`__.

Contribute to model zoo
-----------------------
Expand Down
5 changes: 3 additions & 2 deletions docs/index.rst
Expand Up @@ -99,8 +99,9 @@ This toolkit assumes that users have basic knowledge about deep learning and
NLP. Otherwise, please refer to an introductory course such as
`Dive into Deep Learning <https://www.d2l.ai/>`_ or
`Stanford CS224n <http://web.stanford.edu/class/cs224n/>`_.
If you are not familiar with Gluon, check out the
`60-min Gluon crash course <http://beta.mxnet.io/guide/crash-course/index.html>`_.
If you are not familiar with Gluon, check out the `Gluon documentation
<http://mxnet.apache.org/versions/master/tutorials/index.html#python-tutorials>`__.
You may find the 60-min Gluon crash course linked from there especially helpful.


.. toctree::
Expand Down