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.

Sign up for GitHub

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

Jump to bottom

sl beta docs #3705

Merged
merged 321 commits into from
Aug 3, 2023
Merged

sl beta docs #3705

merged 321 commits into from
Aug 3, 2023

Conversation

mirnawong1
Copy link
Contributor

@mirnawong1 mirnawong1 commented Jul 11, 2023 •
edited by runleonarun
Loading

fixes #3826

preparing SL docs for public beta, which will include new pages and also change existing pages.

docs project

@mirnawong1 mirnawong1 requested a review from a team as a code owner July 11, 2023 10:55
@netlify
Copy link

netlify bot commented Jul 11, 2023 •
edited
Loading

✅ Deploy Preview for docs-getdbt-com ready!

Name Link
🔨 Latest commit 7777dbd
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/64cbcdc40dfcc10008f854fd
😎 Deploy Preview https://deploy-preview-3705--docs-getdbt-com.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: large This change will more than a week to address and might require more than one person guides Knowledge best suited for Guides labels Jul 11, 2023
mirnawong1
mirnawong1 commented Jul 11, 2023
View reviewed changes
website/docs/docs/use-dbt-semantic-layer/quickstart-sl.md Outdated

**What’s happening internally?**

- Merging the code into your main branch allows dbt Cloud to pull those changes and builds the definition in the manifest produced by the run.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

is this all still correct?

mirnawong1
mirnawong1 commented Jul 13, 2023
View reviewed changes
website/docs/docs/use-dbt-semantic-layer/dbt-sl.md Outdated

## Public beta

MOVING THIS TO RELEASE NOTE SECTION BECAUSE I DONT THINK THIS BELONGS HERE. ANYTHING THAT SAYS PUBLIC BETA CAN LINK TO RN
Copy link
Contributor Author

Choose a reason for hiding this comment

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

i think public beta should not be on this pag and be announced/detailed in the public beta release note. any reference to it can then link to that page. this way, it keeps this page clean and only maintains the relevant/current info

rpourzand
rpourzand reviewed Jul 14, 2023
View reviewed changes
Copy link
Contributor

@rpourzand rpourzand left a comment

Choose a reason for hiding this comment

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

Adding a couple of comments for things to address

website/docs/docs/use-dbt-semantic-layer/dbt-sl.md Outdated Show resolved Hide resolved
website/docs/docs/use-dbt-semantic-layer/quickstart-sl.md Outdated
<SlSetUp/>


## Connect to the APIs
Copy link
Contributor

Choose a reason for hiding this comment

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

I think Connect/Query are probably all one fell swoop; so after Setup, we can say "Connect and Query"

I wonder if we can provide an example with a neutral tool like DataBricks. Or maybe we can use Mode or Hex.. let me think about this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no worries! that would be great and easy enough to call it out that we're using 'name_of_integration" for the quickstart

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok so we dont have docs from mode or hex yet and hoping to get them friday

website/docs/docs/use-dbt-semantic-layer/avail-sl-integrations.md Outdated Show resolved Hide resolved
website/docs/docs/use-dbt-semantic-layer/sl-architecture.md Outdated Show resolved Hide resolved
mirnawong1
mirnawong1 commented Jul 17, 2023
View reviewed changes
website/docs/docs/use-dbt-semantic-layer/quickstart-sl.md

&mdash; **When?** Public Preview will end once the dbt Semantic Layer is available for GA. After GA, the dbt Semantic Layer will only be available to dbt Cloud **Team** and **Enterprise** plans.
<details>
<summary>How are you storing my data?</summary>
Copy link
Contributor Author

@mirnawong1 mirnawong1 Jul 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

hey @marcodamore @cesher, i've chatted with @rpourzand and i think this particular data storing faq isn't correct. i would love to get your thoughts so that i can update it and make sure it's technically accurate. does this sound right?

mirnawong1
mirnawong1 commented Jul 17, 2023
View reviewed changes
website/docs/docs/dbt-cloud-apis/sl-graphql.md Outdated
One benefit of GraphQL is its self documenting nature, so you can explore using our schema explorer(todolink). To give you an idea of the types of commands you can execute, we provide some available calls below.


**Metric Metadata Calls**
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rpourzand do we need to add any info on endpoints? I'm just looking at the content in the discovery api docs, which tells users the request endpoints, and more.

mirnawong1
mirnawong1 commented Aug 3, 2023
View reviewed changes
website/snippets/_sl-partner-links.md Outdated

<LoomVideo id="752e85aabfbf4fa585008a5598f3517a"/>

* **Note** before you connect to these tools, you'll need to first [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) and [generate a service token](/docs/dbt-cloud-apis/service-tokens) to create a Semantic Layer Only service token.
Copy link
Contributor Author

@mirnawong1 mirnawong1 Aug 3, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
* **Note** before you connect to these tools, you'll need to first [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) and [generate a service token](/docs/dbt-cloud-apis/service-tokens) to create a Semantic Layer Only service token.
* **Note** before you connect to these tools, you'll need to first [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) and [generate a service token](/docs/dbt-cloud-apis/service-tokens) with Semantic Layer Only and Metadata Only permissions.```

website/snippets/_new-sl-setup.md Outdated
6. You should see connection information that allows you to connect to downstream tools.
**Note:** If your tool supports JDBC, make sure to save the JDBC URL or individual components (like environment id and host). <!--If it uses the Semantic Layer GraphQL API, save the GraphQL API host information instead.-->

7. Return to the **Project Details** page, then select **Generate Service Token** to create a [Semantic Layer Only service token](/docs/dbt-cloud-apis/service-tokens).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
7. Return to the **Project Details** page, then select **Generate Service Token** to create a [Semantic Layer Only service token](/docs/dbt-cloud-apis/service-tokens).
7. Return to the **Project Details** page, then select **Generate Service Token** to create a [Semantic Layer Only and Metadata Only service token](/docs/dbt-cloud-apis/service-tokens).

mirnawong1
mirnawong1 commented Aug 3, 2023
View reviewed changes
Copy link
Contributor Author

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

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

Updating permissions

mirnawong1
mirnawong1 commented Aug 3, 2023
View reviewed changes
website/snippets/_sl-partner-links.md Outdated

<LoomVideo id="752e85aabfbf4fa585008a5598f3517a"/>

* **Note** before you connect to these tools, you'll need to first [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) and [generate a service token](/docs/dbt-cloud-apis/service-tokens) to create a Semantic Layer Only service token.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
* **Note** before you connect to these tools, you'll need to first [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) and [generate a service token](/docs/dbt-cloud-apis/service-tokens) to create a Semantic Layer Only service token.
* **Note** before you connect to these tools, you'll need to first [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) and [generate a service token](/docs/dbt-cloud-apis/service-tokens) to create a Semantic Layer Only and Metadata Only service token.

mirnawong1
mirnawong1 commented Aug 3, 2023
View reviewed changes
website/snippets/_new-sl-setup.md Outdated
6. You should see connection information that allows you to connect to downstream tools.
**Note:** If your tool supports JDBC, make sure to save the JDBC URL or individual components (like environment id and host). <!--If it uses the Semantic Layer GraphQL API, save the GraphQL API host information instead.-->

7. Return to the **Project Details** page, then select **Generate Service Token** to create a [Semantic Layer Only service token](/docs/dbt-cloud-apis/service-tokens).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
7. Return to the **Project Details** page, then select **Generate Service Token** to create a [Semantic Layer Only service token](/docs/dbt-cloud-apis/service-tokens).
7. Return to the **Project Details** page, then select **Generate Service Token** to create a [Semantic Layer Only and Metadata Only service token](/docs/dbt-cloud-apis/service-tokens).

@mirnawong1 mirnawong1 merged commit 080b237 into current Aug 3, 2023
6 checks passed
@mirnawong1 mirnawong1 deleted the mwong-sl-beta branch August 3, 2023 16:09
@graciegoheen graciegoheen mentioned this pull request Aug 15, 2023
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nghi-ly nghi-ly nghi-ly left review comments

@matthewshaver matthewshaver matthewshaver left review comments

@rpourzand rpourzand rpourzand left review comments

@Jstein77 Jstein77 Jstein77 left review comments

@JKarlavige JKarlavige JKarlavige left review comments

@runleonarun runleonarun runleonarun approved these changes

@marcodamore marcodamore marcodamore approved these changes

Assignees
No one assigned
Labels
auto update content Improvements or additions to content developer blog This content fits on the developer blog. Docs team Authored by the Docs team @dbt Labs guides Knowledge best suited for Guides size: large This change will more than a week to address and might require more than one person
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Broken link "Defining metrics" on docs page for "Metrics"
9 participants
@mirnawong1 @runleonarun @JKarlavige @Jstein77 @rpourzand @marcodamore @matthewshaver @nghi-ly @nhandel