Adapt docs for refactored examples (#2505)

* Adapt docs for refactored examples * Make Github steps simpler * Fix broken link in sources tutorial
rilldata · May 25, 2023 · fb1bec9 · fb1bec9
1 parent 33785df
commit fb1bec9
Show file tree

Hide file tree

Showing 12 changed files with 68 additions and 189 deletions.
diff --git a/README.md b/README.md
@@ -4,27 +4,23 @@ Rill makes it effortless to transform your datasets with SQL and create powerful
 
 ```
 curl -s https://cdn.rilldata.com/install.sh | bash
-rill start my_rill_project
+rill start my-rill-project
 ```
 
 ![home-demo](https://github.com/rilldata/rill-developer/assets/5587788/49d17e80-5f27-408c-bbc9-fdbff7b6b627 "829237828")
 
- Rill's design principles:
+Rill's design principles:
 - _**Feels good to use**_ – powered by Sveltekit & DuckDB = conversation-fast, not wait-ten-seconds-for-result-set fast
 - _**Works with your local and remote datasets**_ – imports and exports Parquet and CSV (s3, gcs, https, local)
 - _**No more data analysis "side-quests"**_ – helps you build intuition about your dataset through automatic profiling
 - _**No "run query" button required**_ – responds to each keystroke by re-profiling the resulting dataset
 - _**Radically simple interactive dashboards**_ – thoughtful, opinionated interactive dashboards defaults to help you quickly derive insights from your data
-- _**Dashboards as code**_ – each step from data to dashboard has versioning, git sharing, and easy project rehydration
+- _**Dashboards as code**_ – each step from data to dashboard has versioning, Git sharing, and easy project rehydration
 
 ## We want to hear from you
 
-You can [file an issue](https://github.com/rilldata/rill-developer/issues/new/choose) or reach us in our [Rill discord](https://bit.ly/3unvA05) channel. Please abide by the [rill community policy](https://github.com/rilldata/rill-developer/blob/main/COMMUNITY-POLICY.md).
-
+You can [file an issue](https://github.com/rilldata/rill-developer/issues/new/choose) or reach us in our [Rill discord](https://bit.ly/3unvA05) channel. Please abide by the [community policy](https://github.com/rilldata/rill-developer/blob/main/COMMUNITY-POLICY.md).
 
 ## Legal
-By downloading and using our application you are agreeing to the [Privacy Policy](https://www.rilldata.com/legal/privacy) and [Rill Terms of Service](https://www.rilldata.com/legal/tos).
-
-
-
 
+By downloading and using our application you are agreeing to the [Privacy Policy](https://www.rilldata.com/legal/privacy) and [Rill Terms of Service](https://www.rilldata.com/legal/tos).
diff --git a/docs/docs/deploy/existing-project.md b/docs/docs/deploy/existing-project.md
@@ -19,26 +19,8 @@ graph LR;
 
 Rill Cloud connects to a repository on Github containing a Rill project, and continuously deploys that project on every push. Therefore, your project must be on Github before you deploy it to Rill.
 
-Follow these steps to push your project to Github:
-
-1. Initialize `git`:
-```
-git init
-```
-2. Add and commit the project files:
-```
-git add .
-git commit -m "Initial commit"
-```
-3. Create a new Github repository on Github: [https://github.com/new](https://github.com/new)
-4. Link `git` to the remote repository
-```
-git remote add origin https://github.com/your-account/your-repo.git
-```
-5. Push your repository to Github
-```
-git push -u origin main
-```
+- If your project is not yet on Github, follow the steps on [https://github.com/new](https://github.com/new) to create a new repository and push your project files to it.
+- If your project is already on Github, make sure you have permission to grant access to it. If you're deploying a project controlled by someone else, first fork or copy it to a repository in your account.
 
 ## Deploy to Rill Cloud
 
@@ -68,7 +50,7 @@ rill project reconcile --refresh
 
 # Change your production branch
 
-By default, Rill deploys from the [default branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#about-the-default-branch) of your git repository. You can change this to any branch you want.
+By default, Rill deploys from the [default branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#about-the-default-branch) of your Git repository. You can change this to any branch you want.
 
 To deploy your project from a different branch, run the following command:
 

diff --git a/docs/docs/develop/import-data.md b/docs/docs/develop/import-data.md
@@ -105,7 +105,7 @@ If you do not have the AWS CLI installed and authenticated, follow these steps:
 
 3. If your organization does not have SSO configured:
 
-    a. Follow the steps described under [How to create an AWS service account using the AWS Management Console](#how-to-create-an-aws-service-account-using-the-aws-management-console), which you will find below on this page.
+    a. Follow the steps described in [How to create an AWS service account using the AWS Management Console](../deploy/credentials/s3.md#how-to-create-an-aws-service-account-using-the-aws-management-console) in our tutorial for [Amazon S3 credentials](../deploy/credentials/s3.md).
 
     b. Run the following command and provide the access key, access secret, and default region when prompted (you can leave the "Default output format" blank):
     ```

diff --git a/docs/docs/end-to-end.md b/docs/docs/end-to-end.md
diff --git a/docs/docs/get-started.md b/docs/docs/get-started.md
@@ -0,0 +1,51 @@
+---
+title: Get started
+sidebar_label: Get started
+sidebar_position: 10
+---
+
+This tutorial is a step by step guide that will help you install Rill, ingest source data, and deploy a dashboard online.
+
+## Install Rill
+
+Install `rill` on Mac or Linux ([WSL](https://learn.microsoft.com/en-us/windows/wsl/install) for Windows users) using the installation script:
+
+```
+curl -s https://cdn.rilldata.com/install.sh | bash
+```
+
+## Create your project
+
+Start a new Rill project:
+
+```
+rill start my-rill-project
+```
+
+The Rill web app runs locally at `http://localhost:9009` and will create code files in the `my-rill-project` directory.
+
+## Load and transform data
+
+On the welcome screen, initialize an example project or load up Rill with your own data. Use the app to develop data models and dashboards.
+
+## Deploy your dashboard
+
+You can deploy any Rill project with a dashboard to an authenticated hosted endpoint:
+
+1. Create a new Github repository on [https://github.com/new](https://github.com/new) and push your `my-rill-project` directory to it
+2. Setup continuous deployment from Github to Rill Cloud:
+    ```
+    cd my-rill-project
+    rill deploy
+    ```
+
+## Share your dashboard
+
+Projects on Rill Cloud are private by default. To invite others to explore your project, run:
+```
+rill user add
+```
+
+## We want to hear from you
+
+You can file an issue [on GitHub](https://github.com/rilldata/rill-developer/issues/new/choose) or reach us in our [Discord channel](https://bit.ly/3unvA05).
diff --git a/docs/docs/home.md b/docs/docs/home.md
@@ -9,23 +9,22 @@ Rill is the fastest path from data lake to dashboard.  Download Rill to start mo
 
 ```
 curl -s https://cdn.rilldata.com/install.sh | bash
-rill start my_rill_project
+rill start my-rill-project
 ```
 
 ![home-demo](https://github.com/rilldata/rill-developer/assets/5587788/49d17e80-5f27-408c-bbc9-fdbff7b6b627 "829237828")
 
- Rill's design principles:
+Rill's design principles:
 - _**Feels good to use**_ – powered by Sveltekit & DuckDB = conversation-fast, not wait-ten-seconds-for-result-set fast
 - _**Works with your local and remote datasets**_ – imports and exports Parquet and CSV (s3, gcs, https, local)
 - _**No more data analysis "side-quests"**_ – helps you build intuition about your dataset through automatic profiling
 - _**No "run query" button required**_ – responds to each keystroke by re-profiling the resulting dataset
 - _**Radically simple interactive dashboards**_ – thoughtful, opinionated interactive dashboards defaults to help you quickly derive insights from your data
-- _**Dashboards as code**_ – each step from data to dashboard has versioning, git sharing, and easy project rehydration
+- _**Dashboards as code**_ – each step from data to dashboard has versioning, Git sharing, and easy project rehydration
 
 ## We want to hear from you
 We always appreciate hearing from our users and welcome any questions, comments, or concerns you may have. To get in touch with us, there are two options available:
 1. _**File an issue**_: If you have encountered a bug or have a feature request, please [file an issue](https://github.com/rilldata/rill-developer/issues/new/choose) on our GitHub page.You can 
 2. _**Join our Discord channel**_: For general inquiries or if you need help getting started with Rill, we encourage you to join our [Discord community](https://bit.ly/3unvA05).
 
-Please abide by the [rill community policy](https://github.com/rilldata/rill-developer/blob/main/COMMUNITY-POLICY.md).
-
+Please abide by the [community policy](https://github.com/rilldata/rill-developer/blob/main/COMMUNITY-POLICY.md).
diff --git a/docs/docs/reference/cli-cheat-sheet.md b/docs/docs/reference/cli-cheat-sheet.md
diff --git a/docs/docs/reference/project-files/_category_.yml b/docs/docs/reference/project-files/_category_.yml
@@ -1,4 +1,4 @@
-position: 20
+position: 10
 label: Project files
 collapsible: false
 collapsed: false
diff --git a/docs/docs/share/roles-permissions.md b/docs/docs/share/roles-permissions.md
@@ -7,7 +7,7 @@ sidebar_position: 30
 
 Access permissions in Rill Cloud are organized into roles at the organization and project level. It is usually sufficient to grant access at the organization-level because those permissions are inherited for projects by default. 
 
-For information about granting, revoking and changing roles, see [Share with others](./share-rill.md).
+For information about granting, revoking and changing roles, see [Share with others](./user-management.md).
 
 ## Role inheritance
 

diff --git a/docs/docs/share/share-rill.md → docs/docs/share/user-management.md b/docs/docs/share/share-rill.md → docs/docs/share/user-management.md
diff --git a/runtime/connectors/gcs/gcs.go b/runtime/connectors/gcs/gcs.go
@@ -31,7 +31,7 @@ var errNoCredentials = errors.New("empty credentials: set `google_application_cr
 var spec = connectors.Spec{
 	DisplayName:        "Google Cloud Storage",
 	Description:        "Connect to Google Cloud Storage.",
-	ServiceAccountDocs: "https://docs.rilldata.com/connectors/gcs",
+	ServiceAccountDocs: "https://docs.rilldata.com/deploy/credentials/gcs",
 	Properties: []connectors.PropertySchema{
 		{
 			Key:         "path",

diff --git a/runtime/connectors/s3/s3.go b/runtime/connectors/s3/s3.go
@@ -29,7 +29,7 @@ func init() {
 var spec = connectors.Spec{
 	DisplayName:        "Amazon S3",
 	Description:        "Connect to AWS S3 Storage.",
-	ServiceAccountDocs: "https://docs.rilldata.com/connectors/s3",
+	ServiceAccountDocs: "https://docs.rilldata.com/deploy/credentials/s3",
 	Properties: []connectors.PropertySchema{
 		{
 			Key:         "path",