szetszwo commented on code in PR #646: URL: https://github.com/apache/ratis/pull/646#discussion_r874986549
########## ratis-docs/content/cli.md: ########## @@ -23,6 +23,37 @@ 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 + +>Mention: Ratis shell is available starting from Apache Ratis 2.3.0. + +### Build `ratis-shell` from src tarball +Get the ratis src tarball from [Ratis Source Download](https://ratis.apache.org/downloads.html) + +``` +$ tar -C <DST_DIR> -zxvf apache-ratis-*-src.tar.gz + +$ cd <DST_DIR>/apache-ratis-*-src + +$ mvn -DskipTests -Prelease -Papache-release clean package assembly:single +... +[INFO] BUILD SUCCESS + +$ tar -C <DST_DIR>/ratis-shell -xzf ratis-assembly/target/apache-ratis-2.3.0-SNAPSHOT-src.tar.gz + +$ cd <DST_DIR>/ratis-shell/apache-ratis-2.3.0-SNAPSHOT Review Comment: Replace "2.3.0-SNAPSHOT" with "<VERSION>". ########## ratis-docs/content/cli.md: ########## @@ -23,6 +23,37 @@ 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 Review Comment: Since this section is quite short. Let's call it "Setting up the ratis-shell" for including the entire setup and don't have any subsections. ########## ratis-docs/content/cli.md: ########## @@ -23,6 +23,37 @@ 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 + +>Mention: Ratis shell is available starting from Apache Ratis 2.3.0. + +### Build `ratis-shell` from src tarball +Get the ratis src tarball from [Ratis Source Download](https://ratis.apache.org/downloads.html) + +``` +$ tar -C <DST_DIR> -zxvf apache-ratis-*-src.tar.gz + +$ cd <DST_DIR>/apache-ratis-*-src + +$ mvn -DskipTests -Prelease -Papache-release clean package assembly:single +... +[INFO] BUILD SUCCESS + +$ tar -C <DST_DIR>/ratis-shell -xzf ratis-assembly/target/apache-ratis-2.3.0-SNAPSHOT-src.tar.gz Review Comment: It should use the shell.tar.gz but not src.tar.gz. ``` $ tar -C <DST_DIR>/ratis-shell -xzf ratis-assembly/target/apache-ratis-<VERSION>-shell.tar.gz ``` ########## ratis-docs/content/cli.md: ########## @@ -23,6 +23,37 @@ 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 + +>Mention: Ratis shell is available starting from Apache Ratis 2.3.0. + +### Build `ratis-shell` from src tarball +Get the ratis src tarball from [Ratis Source Download](https://ratis.apache.org/downloads.html) + +``` +$ tar -C <DST_DIR> -zxvf apache-ratis-*-src.tar.gz + +$ cd <DST_DIR>/apache-ratis-*-src + +$ mvn -DskipTests -Prelease -Papache-release clean package assembly:single +... +[INFO] BUILD SUCCESS + +$ tar -C <DST_DIR>/ratis-shell -xzf ratis-assembly/target/apache-ratis-2.3.0-SNAPSHOT-src.tar.gz + +$ cd <DST_DIR>/ratis-shell/apache-ratis-2.3.0-SNAPSHOT +``` +TODO(codings-dan): Get `ratis-shell` from bin tarball directly Review Comment: Let's remove this TODO. Otherwise, it will show up in the doc. -- 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]
