Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added new Concepts, Explore and Manage topics #5343

Merged
merged 23 commits into from
Aug 16, 2024
Merged

Conversation

royendo
Copy link
Contributor

@royendo royendo commented Jul 29, 2024

Need some feedback on the following changes, Okay to proceed with creating some content

  1. Reorganizing the sidebar,
    Concepts:

    • Rill Cloud vs Rill Developer
    • What is an OLAP engine (contents from Connect OLAP engine)
  2. Explore
    - Sharing with public URL
    - some notes inline, will add content (gifs) but thoughts on article as a whole?

  3. Added a reference to our tutorials page and a brief summary, can be hidden until Tutorial is ready.

  4. Added mock-users to rill-yaml.md from <manage/security#testing-your-policies> w/screenshot

Added a section on access policies as this is only in the docs/manage/security.md
Pushing some changes that I've been working on, needs some review and input

1) Reorganzing the sidebar,
     - Rill Cloud vs Rill Developer
     - What is an OLAP engine (contents from Connect OLAP engine)

2) Explore/ Sharing with public URL
     - some notes inline, will add content (gifs) but thoughts on article as a whole?

3) Added a reference to our tutorials page and a brief summary, can be hidden until Tutorial is ready.
@royendo royendo requested a review from AndrewRTsao July 29, 2024 02:19
Added a gif and touched up the Explore/Sharing with a public URL page.
Thinking about adding some image to the very bottom? Is RC a higher offering than RD?
added olap_connector example to rill.yaml ref guide

some minor cosmetic changes
- User Group Management
- [Dashboard] access policies
- Added Roles/Permsision for usergroup
- Added Project Managment
Added articles:
Concepts:
- Rill Cloud v Rill Developer
- What is an OLAP Engine? [moved from build section]

Explore:
- Sharing with public URL

Manage:
- User Group Management,
- Project Management. (thoughts on graphic?)
@royendo royendo changed the title Not quite ready to merge but wanted some feedback on the current changes Added new Concepts, Explore and Manage topics Jul 31, 2024
@royendo
Copy link
Contributor Author

royendo commented Jul 31, 2024

@AndrewRTsao ,
when you get the chance, can you review the following for additional docs?

Added articles:
Concepts:
- Rill Cloud v Rill Developer
- What is an OLAP Engine? [moved from build section]
Explore:
- Sharing with public URL
Manage:
- User Group Management,
- Project Management. (thoughts on graphic?)

@AndrewRTsao
Copy link
Contributor

Will definitely try to take a look later this week. Thanks Roy!

Realized we dont have any explaining what an organization or project is in Rill.

Depending how much more content is needed, can separate the two.

Manage
Organization & Project Management
User Management
User Group Management
Roles and Permissions
Dashboard Access Policies
cleaning up a few things,
Change quite a bit of content in Deploy Dashboards, (moved some content to project management section

added further content to org/project management
- via UI
- via CLI

At some point, we might need to consider having a via UI secion and via CLI completely separate?
@royendo
Copy link
Contributor Author

royendo commented Aug 6, 2024

Added/modified articles:
Concepts:

  • Rill Cloud v Rill Developer
  • What is an OLAP Engine? [moved from build section]

Deploy:

  • Added UI deploy
  • moved some content to project / org managment

Explore:

  • Sharing with public URL

Manage:

  • User Group Management,
  • Org/ Project Management. (thoughts on graphic?)

Reference

  • Added testing access policies to Rill.yaml

Media

  • PNG and GIFs
  • Added JS for coming soon DIV

royendo and others added 2 commits August 8, 2024 21:02
Copy link
Contributor

@AndrewRTsao AndrewRTsao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some edits, cleaned up some sections / typos, and rewrote a few parts. Good to push - thanks for the work Roy!

## DuckDB

DuckDB is unique in that it can act as both a [source](../../reference/connectors/motherduck.md) and [OLAP engine](../../reference/olap-engines/duckdb.md) for Rill. If you wish to connect to existing tables in DuckDB though, rather than use an external table, you can simply use the [DuckDB connector](../../reference/connectors/motherduck.md#connecting-to-duckdb) to read the table and ingest the data into Rill.
DuckDB is unique in that it can act as both a [source](../../reference/connectors/motherduck.md) and [OLAP engine](../../reference/olap-engines/duckdb.md) for Rill. If you wish to connect to existing tables in DuckDB though, rather than use an external table, you can simply use the [DuckDB connector](../../reference/connectors/motherduck.md#connecting-to-external-duckdb-as-a-source) to read the table and ingest the data into Rill.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may want to correct or extend this so that we clarify that a) DuckDB can indeed be used as a source (1-1 mapping with table) or b) DuckDB is available as the default OLAP engine but this is not configurable (i.e. you can't "bring your own DuckDB" as an OLAP engine).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed a change myself

- Druid
- Pinot

Our team is continually evaluating new OLAP engines to support.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a general rule of thumb, it's helpful to layer in admonitions to keep the text more engaging or highlight specific CTAs (to avoid walls of texts)


Rill offers two unique experiences within our product, **Rill Developer** and **Rill Cloud**.

As the name suggestions Rill Developer is designed around the Developer. Users on Rill Developer will import, wrangle, and explore the data before presenting it to the team. Rill Developer runs locally and when you're ready you can push your changes onto Rill Cloud.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rewrote this a bit as we want to indicate that RD and RC are meant to be used hand-in-hand but also to self-reference to the deploy sections of our docs. That itself likely requires an uplift given the recent deploy changes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@royendo I'm guessing this is still a WIP and meant to be a skeleton / not ready to ship yet?

@AndrewRTsao AndrewRTsao merged commit 5df9d06 into main Aug 16, 2024
2 checks passed
@AndrewRTsao AndrewRTsao deleted the rendo-doc-fixes branch August 16, 2024 19:16
@AndrewRTsao
Copy link
Contributor

@royendo Will merge these changes for now and we can tackle / segment out tutorials separately

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants