Tell users to install dependent os packages, and cleanup old JS refs.
The "jiri profile install foo" command used to automatically install
(with sudo) any required os packages. This functionality changed a few
weeks ago, since some users complained about jiri running unknown
commands with sudo.
In the new world, you must run "jiri os-packages foo", which will
inspect the system for installed packages, and if any new ones need to
be installed, it prints a command (using either "brew" or "apt-get"
depending on the system) that will install the packages for you.
For example:
$ jiri profile os-packages v23:base
apt-get install -y automake
This CL also removes some old references to Nodejs, WSPR, and
JavaScript.
Change-Id: Ifa410e738d71367649f1d89c1aa2085a4e077426
diff --git a/content/community/coding-guidelines.md b/content/community/coding-guidelines.md
index 0e04ee7..196ac94 100644
--- a/content/community/coding-guidelines.md
+++ b/content/community/coding-guidelines.md
@@ -95,12 +95,6 @@
VDL source files into the `go/src` tree at the location that the
generated Go should be placed.
-# JavaScript
-
-Follow the [Node.js Style Guide]. Use our [.jshintrc].
-
-<!-- TODO: Documentation generation (jsdoc). -->
-
# Shell
We prefer Go programs over shell scripts for jobs traditionally given
@@ -109,10 +103,8 @@
If you must write a shell script, follow the
[Google Shell Style Guide].
-[.jshintrc]: https://github.com/vanadium/js/blob/master/.jshintrc
[Effective Go]: http://golang.org/doc/effective_go.html
[Google Shell Style Guide]: https://google-styleguide.googlecode.com/svn/trunk/shell.xml
-[Node.js Style Guide]: https://github.com/felixge/node-style-guide
[RPC]: /glossary.html#remote-procedure-call-rpc-
[VDL]: /glossary.html#vandium-definition-language-vdl-
[brad talk]: http://talks.golang.org/2014/gocon-tokyo.slide#36
diff --git a/content/concepts/device-management.md b/content/concepts/device-management.md
index f548198..b516ded 100644
--- a/content/concepts/device-management.md
+++ b/content/concepts/device-management.md
@@ -10,7 +10,7 @@
A __device__ abstracts a system running Vanadium software, although the device need not be exclusively for Vanadium apps - for example, the system could be running natively installed applications alongside Vanadium applications. Typically, a device is a physical computing device, but a device could also be a virtual machine or a browser environment.
-An __application__ is a piece of software built using Vanadium. We use "app" as shorthand for "application", without adopting any of the specific meanings the term "app" may have elsewhere (e.g. in the context of mobile device app stores). Vanadium applications instantiate the Vanadium runtime. Usually, a running instance of a binary corresponds to an application, though applications can be multi-processed, or can be scripts (such as Node.js applications), or can be [Docker][docker] images.
+An __application__ is a piece of software built using Vanadium. We use "app" as shorthand for "application", without adopting any of the specific meanings the term "app" may have elsewhere (e.g. in the context of mobile device app stores). Vanadium applications instantiate the Vanadium runtime. Usually, a running instance of a binary corresponds to an application, though applications can be multi-processed, or can be scripts, or can be [Docker][docker] images.
Applications are described by an __application envelope__. The envelope
contains information needed by the device to install and run the application,
diff --git a/content/glossary.md b/content/glossary.md
index b621fe8..bbff0a5 100644
--- a/content/glossary.md
+++ b/content/glossary.md
@@ -400,20 +400,6 @@
See also: [VOM specification][vom-spec].
-# WebSocket Proxy (WSPR)
-
-A server (usually called WSPR, pronounced *whisper*) allows JavaScript
-running in a web browser or Node.js to communicate with a Vanadium system.
-WSPR proxies the Vanadium world behind a WebSocket interface.
-
-A JavaScript app uses a Node.js module that implements a WebSocket front-end
-to WSPR. WSPR accepts requests from the app over the WebSocket, sends them on
-as conventional Vanadium RPCs, and returns the responses to the JavaScript app
-via WebSocket.
-
-WSPR as a concept will move from a freestanding server into a browser
-extension, and ultimately become native to browsers.
-
[naming-concepts]: /concepts/naming.html
[rpc-concepts]: /concepts/rpc.html
[vdl-spec]: /designdocs/vdl-spec.html
diff --git a/content/installation/os-x.md b/content/installation/os-x.md
index 7daf86b..badccea 100644
--- a/content/installation/os-x.md
+++ b/content/installation/os-x.md
@@ -36,8 +36,7 @@
Click "Install".
-Note, you can also install all of [Xcode], but that's not needed for Vanadium
-unless you are using the Node.js libraries.
+Note, you can also install all of [Xcode], but that's not needed for Vanadium.
If you are using a version of OS X that is older than 10.9, you will need to get
the command line tools for your version from
diff --git a/content/installation/step-by-step.md b/content/installation/step-by-step.md
index 04a4c1c..577641d 100644
--- a/content/installation/step-by-step.md
+++ b/content/installation/step-by-step.md
@@ -111,12 +111,22 @@
# Additional prerequisites
Some components of Vanadium (e.g. Syncbase) have additional prerequisites,
-including Snappy, LevelDB, and Node.js.
+including Snappy and LevelDB.
-We recommend using the `jiri profile` command to install all such
-prerequisites. This command uses `apt-get` on Linux and `brew` on OS X. Note,
-the `jiri` tool and its various plugins are located in
-`$JIRI_ROOT/.jiri_root/scripts`.
+We recommend using the `jiri profile` command to install the v23:base profile,
+which includes all such prerequisites.
+
+First, install any os packages that the v23:base profile needs. The following
+line will inspect your currently installed packages, and if any additional
+packages need to be installed, it will print a command that will install them.
+Note that the printed command may need to be run as root.
+
+<!-- @packagesBaseProfile @test -->
+```
+jiri profile os-packages v23:base
+```
+
+Then install the prerequisites themselves.
<!-- @installBaseProfile @test -->
```
jiri profile install v23:base
diff --git a/content/testing.md b/content/testing.md
index 0744d9d..6a3c31d 100644
--- a/content/testing.md
+++ b/content/testing.md
@@ -24,8 +24,8 @@
Development also requires Node.js. Install it as follows:
```
-# Adds node to $JIRI_ROOT/environment/cout/node/bin. The Makefile adds this to
-# $PATH automatically.
+# Install the Node.js profile. The Makefile adds the nodejs binary to $PATH
+# automatically.
jiri profile install v23:nodejs
```