diff options
author | Jay Doane <jaydoane@apache.org> | 2021-04-19 20:37:37 -0700 |
---|---|---|
committer | Jay Doane <jaydoane@apache.org> | 2021-04-20 00:12:57 -0700 |
commit | 54c880e9020ee4ea7669345f904c985e54131b40 (patch) | |
tree | ba3ec326ff41e0a06b9ae106294a185d4422ac99 | |
parent | ba03c8e6c49158395b99acb9031e14031b879718 (diff) | |
download | couchdb-54c880e9020ee4ea7669345f904c985e54131b40.tar.gz |
Delete obsolete weatherreport files and documentation
-rw-r--r-- | src/weatherreport/.travis.yml | 8 | ||||
-rw-r--r-- | src/weatherreport/DEVELOPMENT.md | 73 | ||||
-rw-r--r-- | src/weatherreport/Makefile | 27 | ||||
-rw-r--r-- | src/weatherreport/README.md | 18 | ||||
-rw-r--r-- | src/weatherreport/doc/overview.edoc | 23 |
5 files changed, 0 insertions, 149 deletions
diff --git a/src/weatherreport/.travis.yml b/src/weatherreport/.travis.yml deleted file mode 100644 index ec6b937b0..000000000 --- a/src/weatherreport/.travis.yml +++ /dev/null @@ -1,8 +0,0 @@ -language: erlang -notifications: - disabled: true -env: - - R15B - - R14B04 - - R14B03 - - R14B02 diff --git a/src/weatherreport/DEVELOPMENT.md b/src/weatherreport/DEVELOPMENT.md deleted file mode 100644 index 129e96499..000000000 --- a/src/weatherreport/DEVELOPMENT.md +++ /dev/null @@ -1,73 +0,0 @@ -# WeatherReport Development - -WeatherReport requires a sane GNU build system and a recent version of -Erlang. It has `twig` and `getopt` as dependencies, so those must be -compatible with your version of Erlang. Release versions are currently -built with Erlang version R14B03, while development versions are targeted at Erlang version R14B04. - -See the `rebar.config` file for more details. - -To build WeatherReport, simply run `make`: - -```bash -$ make -./rebar get-deps -==> weatherreport (get-deps) -Pulling getopt from {git,"git://github.com/jcomellas/getopt.git", - {tag,"v0.4.3"}} -Cloning into 'getopt'... -Pulling twig from {git,"https://github.com/cloudant/twig.git",master} -Cloning into 'twig'... -Pulling config from {git,"git://github.com/cloudant/config.git",{tag,"0.2.5"}} -Cloning into 'config'... -==> getopt (get-deps) -==> twig (get-deps) -==> config (get-deps) -./rebar compile -==> getopt (compile) -Compiled src/getopt.erl -==> twig (compile) -Compiled src/twig_sup.erl -Compiled src/twig_util.erl -Compiled src/twig_app.erl -Compiled src/twig_event_handler.erl -Compiled src/twig.erl -Compiled src/twig_monitor.erl -Compiled src/trunc_io.erl -==> config (compile) -Compiled src/config_listener.erl -Compiled src/config_sup.erl -Compiled src/config_app.erl -Compiled src/config_util.erl -Compiled src/config_writer.erl -Compiled src/config.erl -==> weatherreport (compile) -Compiled src/weatherreport_check.erl -Compiled src/weatherreport_config.erl -Compiled src/weatherreport_util.erl -Compiled src/weatherreport_node.erl -Compiled src/weatherreport_check_nodes_connected.erl -Compiled src/weatherreport_check_memory_use.erl -Compiled src/weatherreport_check_membership.erl -Compiled src/weatherreport.erl -./rebar escriptize -==> getopt (escriptize) -==> twig (escriptize) -==> config (escriptize) -==> weatherreport (escriptize) -``` - -Now you can invoke the script manually via the below command: - -```bash -$ ./weatherreport --etc /path/to/etc [other options] -``` - -To generate the edoc reference, use `make docs` and then open the -`doc/index.html` file in your browser. Detailed discussion of the -internal APIs that you can use in developing new diagnostics is found -in the edocs. - -## Contributing - -We want your code! Fork the [github repository](https://github.com/cloudant/weatherreport) and send a pull request if you'd like to add a new check, contribute improvements to existing checks or improve the way WeatherReport works. diff --git a/src/weatherreport/Makefile b/src/weatherreport/Makefile deleted file mode 100644 index f816ad068..000000000 --- a/src/weatherreport/Makefile +++ /dev/null @@ -1,27 +0,0 @@ -.PHONY: rel deps test - -all: deps compile - -compile: - rebar compile - -deps: - rebar get-deps - -clean: - rebar clean - -distclean: clean - rebar delete-deps - -test: - rebar compile eunit - -escriptize: - rebar escriptize - -## -## Doc targets -## -docs: - rebar doc skip_deps=true diff --git a/src/weatherreport/README.md b/src/weatherreport/README.md index 013ba42c7..8cd687c65 100644 --- a/src/weatherreport/README.md +++ b/src/weatherreport/README.md @@ -11,12 +11,6 @@ $ ./weatherreport --etc /path/to/etc [warning] Cluster member node3@127.0.0.1 is not connected to this node. Please check whether it is down. ``` -## Installation - -WeatherReport depends on features introduced by Erlang version R14B04, so verify that you've installed this version of Erlang before proceeding with installation. - -Installation is currently a matter of cloning the git repository and running `make`. - ## Usage For most cases, you can just run the `weatherreport` command as given at the top of this README. However, sometimes you might want to know some extra detail or run only specific checks. For that, there are command-line options. Execute `weatherreport --help` to learn more about these options: @@ -72,15 +66,3 @@ Finally, if you want to run just a single diagnostic or a list of specific ones, $ ./weatherreport --etc /path/to/etc nodes_connected [warning] Cluster member node3@127.0.0.1 is not connected to this node. Please check whether it is down. ``` - -## Contributing - -0. Read DEVELOPMENT.md -1. Fork the project on [Github](https://github.com/cloudant/weatherreport). -2. Make your changes or additions on a "topic" branch, test and - document them. If you are making a new diagnostic, make sure you - give some module-level information about the checks it - performs. *Note*: diagnostics _should not_ make modifications, only - inspect things. -3. Push to your fork and send a pull-request. -4. A project committer will review your pull-request and get back to you. diff --git a/src/weatherreport/doc/overview.edoc b/src/weatherreport/doc/overview.edoc deleted file mode 100644 index 30dbd18af..000000000 --- a/src/weatherreport/doc/overview.edoc +++ /dev/null @@ -1,23 +0,0 @@ -@author Basho Technologies, Inc. -@copyright 2011 Basho Technologies, Inc. -@version 1.0.0 -@title riaknostic: Automated diagnostic tools for Riak -@doc <p>riaknostic is an escript and set of tools that diagnoses common problems which could affect a Riak node or cluster. When experiencing any problem with Riak, riaknostic should be the first thing run during troubleshooting. The tool is integrated with Riak via the <code>riak-admin</code> script.</p> - -<pre>$ riak-admin diag</pre> - -<p>This documentation describes the <code>riaknostic</code> API and user interface commands. The application's core consists of 5 modules:</p> - -<ul> -<li><strong>riaknostic</strong> - the core of the script, including CLI parsing and dispatching commands.</li> -<li><strong>riaknostic_check</strong> - the behaviour module that all diagnostics must implement, including some general - functions that support the <code>riaknostic</code> module.</li> -<li><strong>riaknostic_config</strong> - convenience functions for inspecting the configuration of the local Riak node.</li> -<li><strong>riaknostic_node</strong> - functions for sending commands to or inspecting the local Riak node or all members of the cluster.</li> -<li><strong>riaknostic_util</strong> - utility functions, including for running shell programs</li> -</ul> - -<p>All other included modules are generally prefixed with <code>riaknostic_check_</code> and are individual diagnostics that can be run.</p> - -<p>riaknostic is licensed under the Apache v2 license.</p> -@end
\ No newline at end of file |