Merge branch 'current' into tlento-create-metric-update

.github/ISSUE_TEMPLATE/improve-docs.yml → .github/ISSUE_TEMPLATE/a-improve-docs.yml

@@ -5,7 +5,7 @@ body:
   - type: markdown
     attributes:
       value: |
-        * You can ask questions or submit ideas for the dbt docs in [Discussions](https://github.com/dbt-labs/docs.getdbt.com/discussions)
+        * You can ask questions or submit ideas for the dbt docs in [Issues](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose)
         * Before you file an issue read the [Contributing guide](https://github.com/dbt-labs/docs.getdbt.com#contributing).
         * Check to make sure someone hasn't already opened a similar [issue](https://github.com/dbt-labs/docs.getdbt.com/issues).
 
@@ -39,4 +39,4 @@ body:
       label: Additional information
       description: Add any other context or screenshots about the feature request here.
     validations:
-      required: false
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,5 @@
 blank_issues_enabled: true
 contact_links:
-  - name: Want to see new content? Open a discussion!
-    url: https://github.com/dbt-labs/docs.getdbt.com/discussions/new
-    about: You can open a discussion to propose new content for the dbt product documentation.
   - name: Have questions about dbt? Join the Community!
     url: https://www.getdbt.com/community/join-the-community
     about: You can join the dbt Labs Community to ask and answer questions.

.github/ISSUE_TEMPLATE/contribute-to-developer-blog.yml

@@ -1,4 +1,4 @@
-name: Contribute to the dbt Developer Blog
+name: Propose a dbt Developer Blog idea
 description: >
   For proposing a new post on the dbt Developer Blog.
 labels: ["content","developer blog"]

.github/ISSUE_TEMPLATE/improve-the-site.yml

@@ -1,11 +1,11 @@
-name: Improve the docs.getdbt.com site
-description: Make a suggestion or report a problem about the technical implementation of docs.getdbt.com.
-labels: ["engineering"]
+name: Report a docs.getdbt.com site issue
+description: Report a problem about the technical implementation of docs.getdbt.com.
+labels: ["engineering","bug"]
 body:
   - type: markdown
     attributes:
       value: |
-        * You can ask questions or submit ideas for the dbt docs in [Discussions](https://github.com/dbt-labs/docs.getdbt.com/discussions)
+        * You can ask questions or submit ideas for the dbt docs in [Issues](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose)
         * Before you file an issue read the [Contributing guide](https://github.com/dbt-labs/docs.getdbt.com#contributing).
         * Check to make sure someone hasn't already opened a similar [issue](https://github.com/dbt-labs/docs.getdbt.com/issues).
 
@@ -39,4 +39,4 @@ body:
       label: Additional information
       description: Any additional information, configuration, or data that might be necessary to reproduce the issue.
     validations:
-      required: false
+      required: false

.github/ISSUE_TEMPLATE/zzz_add-adapter-to-trusted-list.yml

@@ -0,0 +1,62 @@
+name: Add adapter to Trusted list
+description: For adapter maintainers who wish to have theirs added to the list of Trusted adapters.
+title: "Trust dbt-myadapter"
+labels: ["adapter maintainers"]
+assignees:
+  - dataders
+body:
+  - type: markdown
+    attributes:
+      value: |
+        We're excited that you'd like to support your adapter formally as "Trusted"! This template will ensure that you are aware of the process and the guidelines. Additionally, that you can vouch that your adapter currently meets the standards of a Trusted adapter. For more information, see [Trusted adapters](https://docs.getdbt.com/docs/trusted-adapters)
+
+  - type: input
+    id: adapter-repo
+    attributes:
+      label: Link to adapter repo
+      description: Please link to the GitHub repo
+    validations:
+      required: true
+
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you?
+      placeholder: your preferred email and/or dbt Slack handle
+    validations:
+      required: true
+
+  - type: dropdown
+    id: author_type
+    attributes:
+      label: Which of these best describes you?
+      options:
+        - I am a dbt Community member
+        - I work for the vendor on top of which the dbt adapter functions
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: read-program-guide
+    attributes:
+      label: Please agree to the each of the following
+      options:
+        - label: I am a maintainer of the adapter being submited for Trusted status
+          required: true
+        - label: I have read both the [Trusted adapters](https://docs.getdbt.com/docs/trusted-adapters) and [Building a Trusted Adapter](https://docs.getdbt.com/guides/dbt-ecosystem/adapter-development/8-building-a-trusted-adapter) pages.
+          required: true
+        - label: I believe that the adapter currently meets the expectations given above
+          required: true
+        - label: I will ensure this adapter stays in compliance with the guidelines
+          required: true
+        - label: I understand that dbt Labs reserves the right to remove an adapter from the trusted adapter list at any time, should any of the below guidelines not be met
+          required: true
+
+  - type: textarea
+    id: icon
+    attributes:
+      label: What icon should be used?
+      description: |
+        Please share an svg image that you'd like to be displayed in for your adapter. Normally, this is the logo for the data platform on top of which your adapter works. If there's a dark mode version, please also share that.
+        Pasting the image from your clipboard will upload the file to GitHub and create markdown formatting for it to be rendered inline

.github/labeler.yml

@@ -3,6 +3,7 @@ developer blog:
 
 guides:
 - website/docs/guides/**/*
+- website/docs/quickstarts/**/*
 
 content:
 - website/docs/**/*

.github/pull_request_template.md

@@ -10,9 +10,10 @@ To learn more about the writing conventions used in the dbt Labs docs, see the [
 <!--
 Uncomment if you're publishing docs for a prerelease version of dbt (delete if not applicable):
 - [ ] Add versioning components, as described in [Versioning Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
-- [ ] Add a note to the prerelease version [Migration Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/guides/migration/versions)
+- [ ] Add a note to the prerelease version [Migration Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
 -->
-- [ ] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) and [About versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) so my content adheres to these guidelines.
+- [ ] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines.
+- [ ] For [docs versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning), review how to [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
 - [ ] Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."
 
 Adding new pages (delete if not applicable):
@@ -22,4 +23,4 @@ Adding new pages (delete if not applicable):
 Removing or renaming existing pages (delete if not applicable):
 - [ ] Remove page from `website/sidebars.js`
 - [ ] Add an entry `website/static/_redirects`
-- [ ] [Ran link testing](https://github.com/dbt-labs/docs.getdbt.com#running-the-cypress-tests-locally) to update the links that point to the deleted page
+- [ ] Run link testing locally with `npm run build` to update the links that point to the deleted page

.github/workflows/asana-connection.yml

@@ -0,0 +1,17 @@
+name: Show PR Status in Asana
+on:
+  pull_request:
+    types: [opened, reopened]
+
+jobs:
+  create-asana-attachment-job:
+    runs-on: ubuntu-latest
+    name: Create pull request attachments on Asana tasks
+    steps:
+      - name: Create pull request attachments
+        uses: Asana/create-app-attachment-github-action@latest
+        id: postAttachment
+        with:
+          asana-secret: ${{ secrets.ASANA_SECRET }}
+      - name: Log output status
+        run: echo "Status is ${{ steps.postAttachment.outputs.status }}"

.github/workflows/autogenerated_labeler.yml

@@ -0,0 +1,40 @@
+# **what?**
+# Labels issues autogenerated in dbt-core
+
+# **why?**
+# To organize autogenerated issues from dbt-core to make it easier to find and track them.
+
+# **when?**
+# When an issue is opened by the FishtownBuildBot
+
+name: Add Labels to Autogenerated Issues
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  add_customized_labels:
+    if: github.event.issue.user.login == 'FishtownBuildBot'
+    permissions:
+      issues: write
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Determine appropriate labels by repo in title"
+        id: repo
+        env:
+          ISSUE_TITLE: ${{ github.event.issue.title }}
+        run: |
+          if [[ "$ISSUE_TITLE" == *"dbt-core"* ]]; then
+            echo "labels='content,improvement,dbt Core'" >> $GITHUB_OUTPUT
+          else
+            echo "labels='content,improvement,adapters'" >> $GITHUB_OUTPUT
+          fi
+
+      - name: "Add Labels to autogenerated Issues"
+        id: add-labels
+        run: |
+          gh issue edit ${{ github.event.issue.number }} --repo ${{ github.repository }} --add-label ${{ steps.repo.outputs.labels }}
+        env:
+          GH_TOKEN: ${{ secrets.DOCS_SECRET }}

.github/workflows/crawler.yml

@@ -0,0 +1,33 @@
+name: Algolia Crawler
+on:
+  pull_request:
+    types: 
+      - closed
+
+jobs:
+  algolia_recrawl:
+    # Comment out the if check below if running on every merge to current branch
+    if: |
+      contains(github.event.pull_request.labels.*.name, 'trigger-crawl') 
+      && github.event.pull_request.merged == true
+    name: Trigger Algolia Crawl
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout repo
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      # Wait 8 minutes to allow Vercel build to complete
+      - run: sleep 480
+
+      # Once deploy URL is found, trigger Algolia crawl
+      - name: Run Algolia Crawler
+        uses: algolia/algoliasearch-crawler-github-actions@v1
+        id: crawler_push
+        with:
+          crawler-user-id: ${{ secrets.CRAWLER_USER_ID }}
+          crawler-api-key: ${{ secrets.CRAWLER_API_KEY }}
+          algolia-app-id: ${{ secrets.ALGOLIA_APP_ID }}
+          algolia-api-key: ${{ secrets.ALGOLIA_API_KEY }}
+          site-url: 'https://docs.getdbt.com'
+          crawler-name: ${{ secrets.CRAWLER_NAME }}

.github/workflows/label.yml

@@ -2,37 +2,45 @@ name: Add/Remove Labels
 
 on:
   pull_request_target:
-    types: [ opened, closed ]
+    types: [opened]
 
 jobs:
   add_new_contributor_label:
     if: github.event.action == 'opened'
-    permissions:
-      contents: read
-      pull-requests: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
-        with:
-          script: |
-            const creator = context.payload.sender.login
+    - name: Add new contributor label
+      uses: actions/github-script@v6
+      with:
+        github-token: ${{ secrets.DOCS_SECRET }}
+        script: |
+            const creator = context.payload.sender.login;
             const opts = github.rest.issues.listForRepo.endpoint.merge({
               ...context.issue,
               creator,
-              state: 'all'
-            })
-            const issues = await github.paginate(opts)
+              state: 'all',
+            });
+            
+            const issues = await github.paginate(opts);
+            
+            let isAlreadyContributor = false;
+            
             for (const issue of issues) {
               if (issue.number === context.issue.number) {
-                continue
+                continue;
               }
-              if (issue.pull_request) {
-                return // creator is already a contributor
+              if (issue.pull_request && issue.user.login === creator) {
+                isAlreadyContributor = true;
+                break;
               }
             }
-            await github.rest.issues.addLabels({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              labels: ['new contributor']
-            })
+            
+            if (!isAlreadyContributor) {
+              console.log('Adding label: new contributor');
+              await github.rest.issues.addLabels({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                labels: ['new contributor'],
+              });
+            } 

.github/workflows/labeler.yml

@@ -5,8 +5,8 @@
 
 name: "Pull Request Labeler"
 on:
-- pull_request_target
-
+  pull_request_target:
+    types: [opened]
 jobs:
   triage:
     permissions:

.gitignore

@@ -11,10 +11,14 @@ website/yarn.lock
 website/node_modules
 website/i18n/*
 
-# Local vs code 
+# IDE configs
 .vscode
+.idea
+
 # Local Netlify folder
 .netlify
 
-.vscode
 .eslintcache
+
+# Local Vercel folder
+.vercel

README.md

@@ -17,7 +17,7 @@ Creating an inclusive and equitable environment for our documents is more import
 We welcome contributions from community members to this repo:
 - **Fixes**: When you notice an error, you can use the `Edit this page` button at the bottom of each page to suggest a change.
 - **New documentation**: If you contributed code in [dbt-core](https://github.com/dbt-labs/dbt-core), we encourage you to also write the docs here! Please reach out in the dbt community if you need help finding a place for these docs.
-- **Major rewrites**: You can [file an issue](https://github.com/dbt-labs/docs.getdbt.com/issues/new?assignees=&labels=content%2Cimprovement&template=improve-docs.yml) or [start a discussion](https://github.com/dbt-labs/docs.getdbt.com/discussions) to propose ideas for a content area that requires attention.
+- **Major rewrites**: You can [file an issue](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) to propose ideas for a content area that requires attention.
 
 You can use components documented in the [docusaurus library](https://v2.docusaurus.io/docs/markdown-features/).
 
@@ -42,7 +42,7 @@ You can add code snippets and other content in a tabbed view. To learn more abou
 
 # Running the Docs site locally
 
-You can click a link available in a netlify bot PR comment to see and review your changes rendered on a staging server. You are also able to see and review your proposed modifications locally on your computer. Our setup instructions use [homebrew](https://brew.sh/):
+You can click a link available in a Vercel bot PR comment to see and review your changes rendered on a staging server. You are also able to see and review your proposed modifications locally on your computer. Our setup instructions use [homebrew](https://brew.sh/):
 
 ## Prerequisites
 

contributing/adding-page-components.md

@@ -1,6 +1,6 @@
 ## Using warehouse components
 
-You can use the following components to provide code snippets for each supported warehouse. You can see a real-life example in the docs page [Initialize your project](/quickstarts/databricks?step=6).
+You can use the following components to provide code snippets for each supported warehouse. You can see a real-life example in the docs page [Initialize your project](/guides/databricks?step=6).
 
 Identify code by labeling with the warehouse names: