Aaron Markham created MXNET-1078:
------------------------------------
Summary: Installation instructions should be validated
automatically
Key: MXNET-1078
URL: https://issues.apache.org/jira/browse/MXNET-1078
Project: Apache MXNet
Issue Type: Story
Reporter: Aaron Markham
Some installation instructions can be tested automatically. However, when the
instructions are coupled with text for the user, updates can easily break
automation scripts.
I suggest the following approach.
# Create a common flow for the installation instructions for any platform or
language binding.
# The flow should consist of the steps the user should follow and code block
containing each command that should be executed. If there is more than one code
block, the page should end with a complete code block that has all of the steps
in sequence; one that can be executed directly if it were copied and pasted.
# The code blocks can be sourced by an include directive. This will pull the
contents of a text file that contains the commands.
# A nightly CI script can then be invoked to execute the same text file that
the instructions use. Alternatively, multiple CI scripts can be created - one
for each platform and binding combination, so it is clear what fails when
everything else is passing. You can also disable a broken test much easier, and
not disable everything or have constant failures when one thing is broken.
# PRs for installation instructions should be validated against these
requirements.
Timing on implementation is subject to getting the include feature to properly
work with Sphinx, or when Sphinx is replaced with Jekyll for the website
builds. Both platforms support includes, however the Sphinx implementation we
use today seems partially broken and doesn't render includes as described in
the Sphinx documentation.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
