szetszwo commented on code in PR #646: URL: https://github.com/apache/ratis/pull/646#discussion_r873582962
########## ratis-docs/content/cli.md: ########## @@ -23,6 +23,24 @@ Ratis-shell is the command line interface of Ratis. > Ratis-shell is currently only **experimental**. > The compatibility story is not considered for the time being. + +Get the ratis-shell source and Configure environment variables + +``` +$ mvn -DskipTests -Prelease -Papache-release clean package assembly:single Review Comment: We should discuss how to run it from a release. Let's ask the user to download the src tarball from https://ratis.apache.org/downloads.html and mention that ratis shell is available starting from 2.3.0. ########## ratis-docs/content/cli.md: ########## @@ -23,6 +23,24 @@ Ratis-shell is the command line interface of Ratis. > Ratis-shell is currently only **experimental**. > The compatibility story is not considered for the time being. + Review Comment: Let's add a section title. ``` ## Setting up ratis-shell ``` ########## ratis-docs/content/cli.md: ########## @@ -23,6 +23,24 @@ Ratis-shell is the command line interface of Ratis. > Ratis-shell is currently only **experimental**. > The compatibility story is not considered for the time being. + +Get the ratis-shell source and Configure environment variables + +``` +$ mvn -DskipTests -Prelease -Papache-release clean package assembly:single +... +[INFO] BUILD SUCCESS + +$ tar -C /tmp -xzf ratis-assembly/target/apache-ratis-2.3.0-SNAPSHOT-src.tar.gz + +$ cd /tmp/apache-ratis-2.3.0-SNAPSHOT Review Comment: - /tmp seems not a good location since the files could be deleted by the system. - Let's do not hardcode the version number. ``` $ tar -C <DST_DIR> -xzf ratis-assembly/target/apache-ratis-*-src.tar.gz $ cd <DST_DIR>/apache-ratis-<VERSION> ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
