Prepare crates for publishing (#1197)

* Link to the CODE_OF_CONDUCT.md

* Add publish=true to the crates that are going to be published

* Add authors.workspace = true

* Add readme, repository, and homepage to all published crates

* Each crate must have its own README.md

* Document re_memory better

* Update descriptions and README.md:s for all the different crates

* Missing license field for re_viewer

* tweak re_memory/README.md

Co-authored-by: Andreas Reich <[email protected]>

* Expand some README.md:s

---------

Co-authored-by: Andreas Reich <[email protected]>

Author: emilk

ARCHITECTURE.md

@@ -3,6 +3,7 @@ This document describes the technical architecture of Rerun.
 
 ## See also
 * [`BUILD.md`](BUILD.md)
+* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
 * [`CODE_STYLE.md`](CODE_STYLE.md)
 * [`CONTRIBUTING.md`](CONTRIBUTING.md)
 * [`RELEASES.md`](RELEASES.md)

BUILD.md

@@ -4,6 +4,7 @@ This is a guide to how to build Rerun.
 
 ## See also
 * [`ARCHITECTURE.md`](ARCHITECTURE.md)
+* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
 * [`CODE_STYLE.md`](CODE_STYLE.md)
 * [`CONTRIBUTING.md`](CONTRIBUTING.md)
 * [`RELEASES.md`](RELEASES.md)

CODE_OF_CONDUCT.md

@@ -130,4 +130,3 @@ For answers to common questions about this code of conduct, see the FAQ at
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
 [translations]: https://www.contributor-covenant.org/translations
-

CODE_STYLE.md

@@ -3,6 +3,7 @@
 ## See also
 * [`ARCHITECTURE.md`](ARCHITECTURE.md)
 * [`BUILD.md`](BUILD.md)
+* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
 * [`CONTRIBUTING.md`](CONTRIBUTING.md)
 * [`RELEASES.md`](RELEASES.md)
 

CONTRIBUTING.md

@@ -5,6 +5,7 @@ This is written for anyone who wants to contribute to the Rerun repository.
 ## See also
 * [`ARCHITECTURE.md`](ARCHITECTURE.md)
 * [`BUILD.md`](BUILD.md)
+* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
 * [`CODE_STYLE.md`](CODE_STYLE.md)
 * [`RELEASES.md`](RELEASES.md)
 

Cargo.toml

@@ -11,13 +11,13 @@ members = [
 ]
 
 [workspace.package]
-version = "0.1.0"
+authors = ["rerun.io <[email protected]>"]
 edition = "2021"
-rust-version = "1.67"
-license = "MIT OR Apache-2.0"
 homepage = "http://rerun.io"
-readme = "README.md"
+license = "MIT OR Apache-2.0"
 repository = "https://github.com/rerun-io/rerun"
+rust-version = "1.67"
+version = "0.1.0"
 
 [workspace.dependencies]
 anyhow = "1.0"

README.md

@@ -80,6 +80,7 @@ The Rerun open source project targets the needs of individual developers. The co
 # Development
 * [`ARCHITECTURE.md`](ARCHITECTURE.md)
 * [`BUILD.md`](BUILD.md)
+* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
 * [`CODE_STYLE.md`](CODE_STYLE.md)
 * [`CONTRIBUTING.md`](CONTRIBUTING.md)
 * [`RELEASES.md`](RELEASES.md)

RELEASES.md

@@ -5,6 +5,7 @@ This document describes the current release and versioning strategy. This strate
 ## See also
 * [`ARCHITECTURE.md`](ARCHITECTURE.md)
 * [`BUILD.md`](BUILD.md)
+* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
 * [`CODE_STYLE.md`](CODE_STYLE.md)
 * [`CONTRIBUTING.md`](CONTRIBUTING.md)
 

crates/re_analytics/Cargo.toml

@@ -1,10 +1,15 @@
 [package]
 name = "re_analytics"
-version.workspace = true
+authors.workspace = true
+description = "Rerun's analytics SDK"
 edition.workspace = true
-rust-version.workspace = true
+homepage.workspace = true
 license.workspace = true
-publish = false
+publish = true
+readme = "README.md"
+repository.workspace = true
+rust-version.workspace = true
+version.workspace = true
 
 
 [dependencies]

crates/re_analytics/README.md

@@ -1 +1,41 @@
-Rerun's analytics SDK.
+# Rerun's analytics SDK
+
+We use [PostHog](https://posthog.com/) to collect anonymous usage statistics.
+
+Usage data we do collect will be sent to and stored in servers within the EU.
+
+You can audit the actual data being sent out by inspecting the Rerun data directory directly.
+Find out its location by running `rerun analytics config`.
+
+
+### Opting out
+Run `rerun analytics disable` to opt out of all usage data collection.
+
+### What data is collected?
+The exact set of analytics events and parameters can be found here: <https://github.com/rerun-io/rerun/blob/main/crates/re_analytics/src/events.rs>
+
+- We collect high level events about the usage of the Rerun Viewer. For example:
+    - The event 'Viewer Opened' helps us estimate how often Rerun is used.
+    - The event 'Data Source Connected' helps us understand if users tend to use live
+    data sources or recordings most, which helps us prioritize features.
+- We associate events with:
+    - Metadata about the Rerun build (version, target platform, etc).
+    - A persistent random id that is used to associate events from
+        multiple sessions together. To regenerate it run `rerun analytics clear`.
+- We may associate these events with a hashed `application_id` and `recording_id`,
+    so that we can understand if users are more likely to look at few applications often,
+    or tend to use Rerun for many temporary scripts. Again, this helps us prioritize.
+- We may for instance add events that help us understand how well the auto-layout works.
+
+### What data is NOT collected?
+- No Personally Identifiable Information, such as user name or IP address, is collected.
+    - This assumes you don't manually and explicitly associate your email with
+    the analytics events using the analytics helper cli.
+    (Don't do this, it's just meant for internal use for the Rerun team.)
+- No user data logged to Rerun is collected.
+    - In some cases we collect secure hashes of user provided names (e.g. `application_id`),
+    but take great care do this only when we have a clear understanding of why it's needed
+    and it won't risk leaking anything potentially proprietary.
+
+### Why do we collect data?
+- To improve the Rerun open source library.