Skip to content

Commit fcd48ae

Browse files
authored
docs: Rename developers/guides to developers/tutorials (#8776)
* /developers/guides/ -> /developers/tutorials/ * display name * Update README.md
1 parent 8d7dd4c commit fcd48ae

37 files changed

+49
-49
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
<div align="center">
3030

31-
[Docs](https://docs.rilldata.com/)[Install](https://docs.rilldata.com/developers/get-started/install)[Quickstart](https://docs.rilldata.com/developers/get-started/quickstart)[Guides](https://docs.rilldata.com/developers/guides)[Reference](https://docs.rilldata.com/reference/project-files)
31+
[Docs](https://docs.rilldata.com/)[Install](https://docs.rilldata.com/developers/get-started/install)[Quickstart](https://docs.rilldata.com/developers/get-started/quickstart)[Tutorials](https://docs.rilldata.com/developers/tutorials/)[Reference](https://docs.rilldata.com/reference/project-files)
3232

3333
</div>
3434

docs/blog/0.76.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This is especially helpful when embedding Rill—now you can consolidate access
2020
## API Access and Documentation
2121

2222
We’ve added comprehensive documentation and guides for accessing the Rill API and integrating with other systems.
23-
Check out [our guides](/developers/guides/integrating-with-rill) to get started, or explore the full [API reference documentation](/api/admin).
23+
Check out [our guides](/developers/tutorials/integrating-with-rill) to get started, or explore the full [API reference documentation](/api/admin).
2424

2525

2626
## Bug Fixes and Improvements

docs/docs/developers/build/connectors/credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ It's never a good idea to commit sensitive information to Git and it goes agains
9999

100100
If you cloned the project using `rill project clone <project-name>` and are an admin of that project, the credentials will be pulled automatically. Note that there are some limitations with monorepos where credentials may not be pulled correctly. In those cases, credentials are also pulled when running `rill start`, assuming you have already authenticated via the CLI with `rill login`.
101101

102-
For a detailed guide, see our [clone a project guide](/developers/guides/clone-a-project).
102+
For a detailed guide, see our [clone a project guide](/developers/tutorials/clone-a-project).
103103

104104
## Pulling Credentials and Variables from a Deployed Project on Rill Cloud
105105

docs/docs/developers/build/connectors/olap/clickhouse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ driver: clickhouse
111111
managed: true
112112
```
113113

114-
Data ingestion features are not yet available in the UI, please refer to our [model documentation](/reference/project-files/models) on how to ingest data into ClickHouse. For a guide, see [ingesting data directly into ClickHouse](/developers/guides/rill-clickhouse/r_ch_ingest).
114+
Data ingestion features are not yet available in the UI, please refer to our [model documentation](/reference/project-files/models) on how to ingest data into ClickHouse. For a guide, see [ingesting data directly into ClickHouse](/developers/tutorials/rill-clickhouse/r_ch_ingest).
115115

116116

117117
## Read Only Connector

docs/docs/developers/build/connectors/olap/duckdb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ managed: true
2020
2121
:::tip Performance Considerations
2222
23-
DuckDB is an excellent analytical engine but can face performance challenges as data size grows significantly. As a general guideline, we recommend keeping your data size in DuckDB **under 50GB** along with other [performance recommendations](/developers/guides/performance). For larger datasets, Rill still provides excellent performance but may require additional backend optimizations. [Contact us](/contact) if you need assistance with large-scale deployments.
23+
DuckDB is an excellent analytical engine but can face performance challenges as data size grows significantly. As a general guideline, we recommend keeping your data size in DuckDB **under 50GB** along with other [performance recommendations](/developers/tutorials/performance). For larger datasets, Rill still provides excellent performance but may require additional backend optimizations. [Contact us](/contact) if you need assistance with large-scale deployments.
2424
2525
:::
2626

docs/docs/developers/build/connectors/templating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ dsn: "postgres://user:password@localhost:5432/database"
9393
```
9494
9595
## Additional Resources
96-
- [Performance Optimization Guide](/developers/guides/performance)
96+
- [Performance Optimization Guide](/developers/tutorials/performance)
9797
- [Official docs](https://pkg.go.dev/text/template) (Go)
9898
- [Learn Go Template Syntax](https://developer.hashicorp.com/nomad/tutorials/templates/go-template-syntax) (HashiCorp)
9999
- [Sprig Function Documentation](http://masterminds.github.io/sprig/)

docs/docs/developers/deploy/cloud-vs-developer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ hide_table_of_contents: false
99

1010
Rill offers two unique but complementary experiences within our broader product suite, **Rill Cloud** and **Rill Developer**.
1111

12-
As the name suggests, Rill _Developer_ is designed with the developer in mind, where project development actually occurs. Rill Developer is meant for the primary developers of project assets and dashboards, allowing them to import, wrangle, iterate on, and explore the data before presenting it for broader consumption by the team. Rill Developer is meant to run on your local machine - see here for some [recommendations and best practices](/developers/guides/performance#local-development--rill-developer) - but it is a simple process to [deploy a project](/developers/deploy/deploy-dashboard) once ready to Rill Cloud.
12+
As the name suggests, Rill _Developer_ is designed with the developer in mind, where project development actually occurs. Rill Developer is meant for the primary developers of project assets and dashboards, allowing them to import, wrangle, iterate on, and explore the data before presenting it for broader consumption by the team. Rill Developer is meant to run on your local machine - see here for some [recommendations and best practices](/developers/tutorials/performance#local-development--rill-developer) - but it is a simple process to [deploy a project](/developers/deploy/deploy-dashboard) once ready to Rill Cloud.
1313

1414

1515
Rill Cloud, on the other hand, is designed for our dashboard consumers and allows broader team members to easily collaborate. Once the developer has deployed the dashboard onto Rill Cloud, these users will be able to utilize the dashboards to interact with their data, set alerts / bookmarks, investigate nuances / anomalies, or otherwise perform everyday tasks for their business needs at Rill speed.

docs/docs/developers/get-started/get-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ rill start my-rill-project
1919

2020
Take a look at our [Quick start](/developers/get-started/quickstart) for a quick guide to get started with your own data! We use a public GCS dataset but you can follow along with your own data. Take a look at our [connectors docs](/developers/build/connectors) for the exact steps to connect to your data.
2121

22-
Or, if you're looking for more guides, check out our [Guides](/developers/guides) section!
22+
Or, if you're looking for more guides, check out our [Guides](/developers/tutorials/) section!
2323

2424
## Examples
2525

docs/docs/developers/get-started/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ curl https://rill.sh | sh
1313
```
1414

1515
:::tip Why am I installing locally?
16-
Installing Rill Developer locally is required to create a new project, or [clone a project](/developers/guides/clone-a-project) from Rill Cloud. For key differences between Rill Cloud and Rill Developer, see [Rill Cloud vs. Rill Developer](/developers/deploy/cloud-vs-developer).
16+
Installing Rill Developer locally is required to create a new project, or [clone a project](/developers/tutorials/clone-a-project) from Rill Cloud. For key differences between Rill Cloud and Rill Developer, see [Rill Cloud vs. Rill Developer](/developers/deploy/cloud-vs-developer).
1717
:::
1818

1919

docs/docs/developers/get-started/quickstart/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Video from '@site/src/components/Video';
88
<!-- WARNING: There are links to this page in source code. If you move it, find and replace the links and consider adding a redirect in docusaurus.config.js. -->
99

1010
:::tip Rill's Default Engine
11-
This guide assumes you'll be using Rill's default embedded engine, DuckDB. If you're looking to set up Rill with ClickHouse, check out our [ClickHouse Guide](/developers/guides/rill-clickhouse)!
11+
This guide assumes you'll be using Rill's default embedded engine, DuckDB. If you're looking to set up Rill with ClickHouse, check out our [ClickHouse Guide](/developers/tutorials/rill-clickhouse)!
1212
:::
1313

1414
## What is Rill Developer?
@@ -129,4 +129,4 @@ This quick start covered the basics, but Rill offers much more:
129129
- **[Metrics Layer](/developers/build/metrics-view)** - Define business KPIs and calculations
130130
- **[Deployment](/developers/deploy/deploy-dashboard)** - Share your dashboards with your team
131131

132-
Ready to build something more complex? Check out our [comprehensive tutorial](/developers/guides/rill-basics/launch) for a complete walkthrough of Rill's advanced features.
132+
Ready to build something more complex? Check out our [comprehensive tutorial](/developers/tutorials/rill-basics/launch) for a complete walkthrough of Rill's advanced features.

0 commit comments

Comments
 (0)