diff --git a/docs.json b/docs.json index ca55c53..50cdebd 100644 --- a/docs.json +++ b/docs.json @@ -1,20 +1,333 @@ { "$schema": "https://mintlify.com/docs.json", - "theme": "maple", + "theme": "almond", "name": "Dub Documentation", "colors": { - "primary": "#eb5611", - "light": "#eb5611", - "dark": "#eb5611" + "primary": "#171717", + "light": "#51A2FF", + "dark": "#171717" }, "favicon": "/logos/favicon.png", + "fonts": { + "family": "Inter" + }, "contextual": { "options": ["copy", "view", "chatgpt", "claude", "cursor", "vscode"] }, "navigation": { "tabs": [ { - "tab": "Documentation", + "tab": "Help", + "groups": [ + { + "group": "Overview", + "pages": ["help/overview"] + }, + { + "group": "Link Management", + "pages": [ + { + "group": "Basics and creation", + "pages": [ + "help/link-management/create-short-link", + "help/link-management/link-builder", + "help/link-management/dubsh-links-not-working" + ] + }, + { + "group": "Destinations and redirects", + "pages": [ + "help/link-management/check-link-destination", + "help/link-management/double-redirects", + "help/link-management/pass-query-parameters", + "help/link-management/custom-link-previews" + ] + }, + { + "group": "Targeting and routing", + "pages": [ + "help/link-management/device-targeting", + "help/link-management/geo-targeting", + "help/link-management/noindex" + ] + }, + { + "group": "Security and access", + "pages": [ + "help/link-management/password-protected-links", + "help/link-management/link-cloaking" + ] + }, + { + "group": "Organization and management", + "pages": [ + "help/link-management/bulk-link-management", + "help/link-management/export-links", + "help/link-management/links-with-folders", + "help/link-management/folders-rbac", + "help/link-management/transfer-links-between-workspaces", + "help/link-management/link-comments" + ] + }, + { + "group": "Tracking parameters and UTMs", + "pages": [ + "help/link-management/utm-templates", + "help/link-management/add-utm-parameters" + ] + }, + { + "group": "QR codes and experimentation", + "pages": [ + "help/link-management/custom-qr-codes", + "help/link-management/ab-testing" + ] + }, + { + "group": "Expiration and lifecycle", + "pages": ["help/link-management/expiration-date"] + } + ] + }, + { + "group": "Analytics", + "pages": [ + { + "group": "Overview and fundamentals", + "pages": [ + "help/analytics/dub-analytics-overview", + "help/analytics/dub-conversions-overview", + "help/analytics/customer-insights" + ] + }, + { + "group": "Events and data streams", + "pages": [ + "help/analytics/real-time-events-stream", + "help/analytics/tracking-internal-traffic-product-led-growth" + ] + }, + { + "group": "Filtering and segmentation", + "pages": [ + "help/analytics/filter-qr-scans-vs-clicks", + "help/analytics/filter-by-tags", + "help/analytics/filter-by-folders", + "help/analytics/utm-filtering-visualization" + ] + }, + { + "group": "Geography and accuracy", + "pages": ["help/analytics/incorrect-country-city-data"] + }, + { + "group": "Exporting and sharing", + "pages": [ + "help/analytics/export-link-analytics-data", + "help/analytics/public-analytics-dashboards" + ] + }, + { + "group": "Limits and constraints", + "pages": ["help/analytics/analytics-limits"] + } + ] + }, + { + "group": "Dub Partners", + "pages": [ + { + "group": "Overview and foundations", + "pages": [ + "help/dub-partners/overview", + "help/dub-partners/partner-program-landing-page", + "help/dub-partners/brand-and-support-resources" + ] + }, + { + "group": "Partner onboarding and applications", + "pages": [ + "help/dub-partners/inviting-partners", + "help/dub-partners/reviewing-program-applications", + "help/dub-partners/customizing-program-application-form" + ] + }, + { + "group": "Partner management", + "pages": [ + "help/dub-partners/managing-program-partners", + "help/dub-partners/partners-with-groups", + "help/dub-partners/referral-links-partner-groups" + ] + }, + { + "group": "Rewards and incentives", + "pages": [ + "help/dub-partners/configuring-partner-rewards", + "help/dub-partners/dual-sided-incentives" + ] + }, + { + "group": "Payouts and commissions", + "pages": [ + "help/dub-partners/setup-bank-account-payouts", + "help/dub-partners/sending-partner-payouts", + "help/dub-partners/commissions-and-clawbacks" + ] + }, + { + "group": "Messaging and communication", + "pages": [ + "help/dub-partners/messaging-partners", + "help/dub-partners/partner-emails" + ] + }, + { + "group": "Analytics and trust", + "pages": [ + "help/dub-partners/program-performance-analytics", + "help/dub-partners/fraud-detection" + ] + }, + { + "group": "Advanced programs", + "pages": ["help/dub-partners/program-bounties"] + } + ] + }, + { + "group": "Partnering with Programs", + "pages": [ + { + "group": "Getting started", + "pages": [ + "help/partnering-with-programs/navigating-partner-program", + "help/partnering-with-programs/joining-programs-marketplace", + "help/partnering-with-programs/faq" + ] + }, + { + "group": "Partner profile and account", + "pages": [ + "help/partnering-with-programs/updating-partner-profile", + "help/partnering-with-programs/managing-partner-teams", + "help/partnering-with-programs/merging-partner-accounts" + ] + }, + { + "group": "Commissions and payouts", + "pages": [ + "help/partnering-with-programs/commissions-and-payouts", + "help/partnering-with-programs/receiving-partner-payouts", + "help/partnering-with-programs/setting-business-details-in-payout-invoices" + ] + }, + { + "group": "Communication", + "pages": [ + "help/partnering-with-programs/communicating-with-programs" + ] + } + ] + }, + { + "group": "Custom Domains", + "pages": [ + { + "group": "Domain basics", + "pages": [ + "help/custom-domains/default-dub-domains", + "help/custom-domains/free-link-domain-offer", + "help/custom-domains/choose-custom-domain" + ] + }, + { + "group": "Domain setup", + "pages": [ + "help/custom-domains/add-custom-domain", + "help/custom-domains/set-primary-domain", + "help/custom-domains/shorten-links-subpath", + "help/custom-domains/archive-domains" + ] + }, + { + "group": "Domain configuration", + "pages": [ + "help/custom-domains/setup-redirect", + "help/custom-domains/set-not-found-url", + "help/custom-domains/configure-deep-links" + ] + }, + { + "group": "Advanced setups", + "pages": [ + "help/custom-domains/cloudflare-domains", + "help/custom-domains/use-proxy", + "help/custom-domains/transfer-domains-between-workspaces" + ] + }, + "help/custom-domains/troubleshooting" + ] + }, + { + "group": "Workspace", + "pages": [ + "help/workspace-management/what-is-a-workspace", + { + "group": "Team and access", + "pages": [ + "help/workspace-management/invite-teammates", + "help/workspace-management/manage-member-roles" + ] + }, + { + "group": "Authentication", + "pages": [ + "help/saml-sso/scim-okta", + "help/saml-sso/okta", + "help/saml-sso/google-workspace", + "help/saml-sso/azure-ad", + "help/saml-sso/scim-azure-ad" + ] + }, + { + "group": "Billing and usage", + "pages": [ + "help/workspace-management/download-invoice", + "help/workspace-management/change-billing-information", + "help/workspace-management/cancel-subscription", + "help/workspace-management/billing-and-plans", + "help/workspace-management/usage-limits" + ] + } + ] + }, + { + "group": "Migrating to Dub", + "pages": [ + { + "group": "Dub Partners", + "pages": [ + "help/migrating-to-dub/rewardful", + "help/migrating-to-dub/partnerstack", + "help/migrating-to-dub/firstpromoter", + "help/migrating-to-dub/tolt" + ] + }, + { + "group": "Dub Links", + "pages": [ + "help/migrating-to-dub/bitly", + "help/migrating-to-dub/rebrandly", + "help/migrating-to-dub/short-io" + ] + } + ] + } + ] + }, + { + "tab": "Guides", "groups": [ { "group": "Getting Started", @@ -128,7 +441,7 @@ ] }, { - "tab": "APIs and SDKs", + "tab": "APIs & SDKs", "groups": [ { "group": "Overview", @@ -306,18 +619,11 @@ "api": { "openapi": "https://spec.speakeasy.com/dub/dub/dub-with-code-samples" }, - "background": { - "image": "/images/background.png" - }, "navbar": { "links": [ { "label": "Contact support", "href": "https://dub.co/contact/support" - }, - { - "label": "Help Center", - "href": "https://dub.co/help" } ], "primary": { diff --git a/global.css b/global.css new file mode 100644 index 0000000..e0b556b --- /dev/null +++ b/global.css @@ -0,0 +1,4 @@ +#content-area img { + border-radius: 0.5rem; + border: 1px solid rgb(38 38 38 / 0.1); +} diff --git a/help/analytics/analytics-limits.mdx b/help/analytics/analytics-limits.mdx new file mode 100644 index 0000000..72a1bb1 --- /dev/null +++ b/help/analytics/analytics-limits.mdx @@ -0,0 +1,5 @@ +--- +title: Analytics limits +--- + +Content coming soon. diff --git a/help/analytics/customer-insights.mdx b/help/analytics/customer-insights.mdx new file mode 100644 index 0000000..5683a0c --- /dev/null +++ b/help/analytics/customer-insights.mdx @@ -0,0 +1,5 @@ +--- +title: Customer insights +--- + +Content coming soon. diff --git a/help/analytics/dub-analytics-overview.mdx b/help/analytics/dub-analytics-overview.mdx new file mode 100644 index 0000000..4a2e022 --- /dev/null +++ b/help/analytics/dub-analytics-overview.mdx @@ -0,0 +1,5 @@ +--- +title: Analytics overview +--- + +Content coming soon. diff --git a/help/analytics/dub-conversions-overview.mdx b/help/analytics/dub-conversions-overview.mdx new file mode 100644 index 0000000..44f6d0f --- /dev/null +++ b/help/analytics/dub-conversions-overview.mdx @@ -0,0 +1,5 @@ +--- +title: Conversions overview +--- + +Content coming soon. diff --git a/help/analytics/export-link-analytics-data.mdx b/help/analytics/export-link-analytics-data.mdx new file mode 100644 index 0000000..dbddcf1 --- /dev/null +++ b/help/analytics/export-link-analytics-data.mdx @@ -0,0 +1,5 @@ +--- +title: Exporting analytics data +--- + +Content coming soon. diff --git a/help/analytics/filter-by-folders.mdx b/help/analytics/filter-by-folders.mdx new file mode 100644 index 0000000..a49d776 --- /dev/null +++ b/help/analytics/filter-by-folders.mdx @@ -0,0 +1,5 @@ +--- +title: Filtering by folders +--- + +Content coming soon. diff --git a/help/analytics/filter-by-tags.mdx b/help/analytics/filter-by-tags.mdx new file mode 100644 index 0000000..eb16d4d --- /dev/null +++ b/help/analytics/filter-by-tags.mdx @@ -0,0 +1,5 @@ +--- +title: Filtering by tags +--- + +Content coming soon. diff --git a/help/analytics/filter-qr-scans-vs-clicks.mdx b/help/analytics/filter-qr-scans-vs-clicks.mdx new file mode 100644 index 0000000..93c114a --- /dev/null +++ b/help/analytics/filter-qr-scans-vs-clicks.mdx @@ -0,0 +1,5 @@ +--- +title: Filtering QR scans and link clicks +--- + +Content coming soon. diff --git a/help/analytics/incorrect-country-city-data.mdx b/help/analytics/incorrect-country-city-data.mdx new file mode 100644 index 0000000..bcd7de1 --- /dev/null +++ b/help/analytics/incorrect-country-city-data.mdx @@ -0,0 +1,5 @@ +--- +title: Geography data accuracy +--- + +Content coming soon. diff --git a/help/analytics/public-analytics-dashboards.mdx b/help/analytics/public-analytics-dashboards.mdx new file mode 100644 index 0000000..ad79593 --- /dev/null +++ b/help/analytics/public-analytics-dashboards.mdx @@ -0,0 +1,5 @@ +--- +title: Public analytics dashboards +--- + +Content coming soon. diff --git a/help/analytics/real-time-events-stream.mdx b/help/analytics/real-time-events-stream.mdx new file mode 100644 index 0000000..4565ccd --- /dev/null +++ b/help/analytics/real-time-events-stream.mdx @@ -0,0 +1,5 @@ +--- +title: Real time events stream +--- + +Content coming soon. diff --git a/help/analytics/tracking-internal-traffic-product-led-growth.mdx b/help/analytics/tracking-internal-traffic-product-led-growth.mdx new file mode 100644 index 0000000..5abe39d --- /dev/null +++ b/help/analytics/tracking-internal-traffic-product-led-growth.mdx @@ -0,0 +1,5 @@ +--- +title: Tracking internal and product led traffic +--- + +Content coming soon. diff --git a/help/analytics/utm-filtering-visualization.mdx b/help/analytics/utm-filtering-visualization.mdx new file mode 100644 index 0000000..bfe3f49 --- /dev/null +++ b/help/analytics/utm-filtering-visualization.mdx @@ -0,0 +1,5 @@ +--- +title: Filtering by UTM parameters +--- + +Content coming soon. diff --git a/help/custom-domains/add-custom-domain.mdx b/help/custom-domains/add-custom-domain.mdx new file mode 100644 index 0000000..56591e8 --- /dev/null +++ b/help/custom-domains/add-custom-domain.mdx @@ -0,0 +1,5 @@ +--- +title: Adding a custom domain +--- + +Content coming soon. diff --git a/help/custom-domains/archive-domains.mdx b/help/custom-domains/archive-domains.mdx new file mode 100644 index 0000000..72b1404 --- /dev/null +++ b/help/custom-domains/archive-domains.mdx @@ -0,0 +1,5 @@ +--- +title: Archiving domains +--- + +Content coming soon. diff --git a/help/custom-domains/choose-custom-domain.mdx b/help/custom-domains/choose-custom-domain.mdx new file mode 100644 index 0000000..88e5fc2 --- /dev/null +++ b/help/custom-domains/choose-custom-domain.mdx @@ -0,0 +1,5 @@ +--- +title: Choosing a custom domain +--- + +Content coming soon. diff --git a/help/custom-domains/cloudflare-domains.mdx b/help/custom-domains/cloudflare-domains.mdx new file mode 100644 index 0000000..1ece7a7 --- /dev/null +++ b/help/custom-domains/cloudflare-domains.mdx @@ -0,0 +1,5 @@ +--- +title: Cloudflare domains +--- + +Content coming soon. diff --git a/help/custom-domains/configure-deep-links.mdx b/help/custom-domains/configure-deep-links.mdx new file mode 100644 index 0000000..15afbb6 --- /dev/null +++ b/help/custom-domains/configure-deep-links.mdx @@ -0,0 +1,5 @@ +--- +title: Deep links on custom domains +--- + +Content coming soon. diff --git a/help/custom-domains/default-dub-domains.mdx b/help/custom-domains/default-dub-domains.mdx new file mode 100644 index 0000000..917867c --- /dev/null +++ b/help/custom-domains/default-dub-domains.mdx @@ -0,0 +1,5 @@ +--- +title: Default Dub domains +--- + +Content coming soon. diff --git a/help/custom-domains/free-link-domain-offer.mdx b/help/custom-domains/free-link-domain-offer.mdx new file mode 100644 index 0000000..0b5644b --- /dev/null +++ b/help/custom-domains/free-link-domain-offer.mdx @@ -0,0 +1,5 @@ +--- +title: Free .link domains +--- + +Content coming soon. diff --git a/help/custom-domains/set-not-found-url.mdx b/help/custom-domains/set-not-found-url.mdx new file mode 100644 index 0000000..f51037a --- /dev/null +++ b/help/custom-domains/set-not-found-url.mdx @@ -0,0 +1,5 @@ +--- +title: Custom 404 pages +--- + +Content coming soon. diff --git a/help/custom-domains/set-primary-domain.mdx b/help/custom-domains/set-primary-domain.mdx new file mode 100644 index 0000000..ba006a1 --- /dev/null +++ b/help/custom-domains/set-primary-domain.mdx @@ -0,0 +1,5 @@ +--- +title: Setting a primary domain +--- + +Content coming soon. diff --git a/help/custom-domains/setup-redirect.mdx b/help/custom-domains/setup-redirect.mdx new file mode 100644 index 0000000..50f5277 --- /dev/null +++ b/help/custom-domains/setup-redirect.mdx @@ -0,0 +1,5 @@ +--- +title: Domain level redirects +--- + +Content coming soon. diff --git a/help/custom-domains/shorten-links-subpath.mdx b/help/custom-domains/shorten-links-subpath.mdx new file mode 100644 index 0000000..ed01f29 --- /dev/null +++ b/help/custom-domains/shorten-links-subpath.mdx @@ -0,0 +1,5 @@ +--- +title: Using subpaths for short links +--- + +Content coming soon. diff --git a/help/custom-domains/transfer-domains-between-workspaces.mdx b/help/custom-domains/transfer-domains-between-workspaces.mdx new file mode 100644 index 0000000..6247bdc --- /dev/null +++ b/help/custom-domains/transfer-domains-between-workspaces.mdx @@ -0,0 +1,5 @@ +--- +title: Transferring domains between workspaces +--- + +Content coming soon. diff --git a/help/custom-domains/troubleshooting.mdx b/help/custom-domains/troubleshooting.mdx new file mode 100644 index 0000000..f08ab3b --- /dev/null +++ b/help/custom-domains/troubleshooting.mdx @@ -0,0 +1,5 @@ +--- +title: Troubleshooting custom domains +--- + +Content coming soon. diff --git a/help/custom-domains/use-proxy.mdx b/help/custom-domains/use-proxy.mdx new file mode 100644 index 0000000..79cce6f --- /dev/null +++ b/help/custom-domains/use-proxy.mdx @@ -0,0 +1,5 @@ +--- +title: Using a proxy with custom domains +--- + +Content coming soon. diff --git a/help/dub-partners/brand-and-support-resources.mdx b/help/dub-partners/brand-and-support-resources.mdx new file mode 100644 index 0000000..5963a30 --- /dev/null +++ b/help/dub-partners/brand-and-support-resources.mdx @@ -0,0 +1,5 @@ +--- +title: Brand and support resources +--- + +Content coming soon. diff --git a/help/dub-partners/commissions-and-clawbacks.mdx b/help/dub-partners/commissions-and-clawbacks.mdx new file mode 100644 index 0000000..c40d93c --- /dev/null +++ b/help/dub-partners/commissions-and-clawbacks.mdx @@ -0,0 +1,5 @@ +--- +title: Commissions and clawbacks +--- + +Content coming soon. diff --git a/help/dub-partners/configuring-partner-rewards.mdx b/help/dub-partners/configuring-partner-rewards.mdx new file mode 100644 index 0000000..7cb14cc --- /dev/null +++ b/help/dub-partners/configuring-partner-rewards.mdx @@ -0,0 +1,5 @@ +--- +title: Partner rewards +--- + +Content coming soon. diff --git a/help/dub-partners/customizing-program-application-form.mdx b/help/dub-partners/customizing-program-application-form.mdx new file mode 100644 index 0000000..a54a5f2 --- /dev/null +++ b/help/dub-partners/customizing-program-application-form.mdx @@ -0,0 +1,5 @@ +--- +title: Customizing application forms +--- + +Content coming soon. diff --git a/help/dub-partners/dual-sided-incentives.mdx b/help/dub-partners/dual-sided-incentives.mdx new file mode 100644 index 0000000..aeb4044 --- /dev/null +++ b/help/dub-partners/dual-sided-incentives.mdx @@ -0,0 +1,5 @@ +--- +title: Dual sided incentives +--- + +Content coming soon. diff --git a/help/dub-partners/fraud-detection.mdx b/help/dub-partners/fraud-detection.mdx new file mode 100644 index 0000000..903d53a --- /dev/null +++ b/help/dub-partners/fraud-detection.mdx @@ -0,0 +1,5 @@ +--- +title: Fraud detection +--- + +Content coming soon. diff --git a/help/dub-partners/inviting-partners.mdx b/help/dub-partners/inviting-partners.mdx new file mode 100644 index 0000000..760883a --- /dev/null +++ b/help/dub-partners/inviting-partners.mdx @@ -0,0 +1,5 @@ +--- +title: Inviting partners +--- + +Content coming soon. diff --git a/help/dub-partners/managing-program-partners.mdx b/help/dub-partners/managing-program-partners.mdx new file mode 100644 index 0000000..136bb5b --- /dev/null +++ b/help/dub-partners/managing-program-partners.mdx @@ -0,0 +1,5 @@ +--- +title: Managing partners +--- + +Content coming soon. diff --git a/help/dub-partners/messaging-partners.mdx b/help/dub-partners/messaging-partners.mdx new file mode 100644 index 0000000..e96921e --- /dev/null +++ b/help/dub-partners/messaging-partners.mdx @@ -0,0 +1,5 @@ +--- +title: Partner messaging +--- + +Content coming soon. diff --git a/help/dub-partners/migrating-from-firstpromoter.mdx b/help/dub-partners/migrating-from-firstpromoter.mdx new file mode 100644 index 0000000..71db0a0 --- /dev/null +++ b/help/dub-partners/migrating-from-firstpromoter.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from FirstPromoter +--- + +Content coming soon. diff --git a/help/dub-partners/migrating-from-partnerstack.mdx b/help/dub-partners/migrating-from-partnerstack.mdx new file mode 100644 index 0000000..dbda0bc --- /dev/null +++ b/help/dub-partners/migrating-from-partnerstack.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from PartnerStack +--- + +Content coming soon. diff --git a/help/dub-partners/migrating-from-rewardful.mdx b/help/dub-partners/migrating-from-rewardful.mdx new file mode 100644 index 0000000..d107a6d --- /dev/null +++ b/help/dub-partners/migrating-from-rewardful.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from Rewardful +--- + +Content coming soon. diff --git a/help/dub-partners/migrating-from-tolt.mdx b/help/dub-partners/migrating-from-tolt.mdx new file mode 100644 index 0000000..715e46e --- /dev/null +++ b/help/dub-partners/migrating-from-tolt.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from Tolt +--- + +Content coming soon. diff --git a/help/dub-partners/overview.mdx b/help/dub-partners/overview.mdx new file mode 100644 index 0000000..c4818b1 --- /dev/null +++ b/help/dub-partners/overview.mdx @@ -0,0 +1,5 @@ +--- +title: Partners overview +--- + +Content coming soon. diff --git a/help/dub-partners/partner-emails.mdx b/help/dub-partners/partner-emails.mdx new file mode 100644 index 0000000..b0772aa --- /dev/null +++ b/help/dub-partners/partner-emails.mdx @@ -0,0 +1,5 @@ +--- +title: Partner emails +--- + +Content coming soon. diff --git a/help/dub-partners/partner-program-landing-page.mdx b/help/dub-partners/partner-program-landing-page.mdx new file mode 100644 index 0000000..3b46461 --- /dev/null +++ b/help/dub-partners/partner-program-landing-page.mdx @@ -0,0 +1,5 @@ +--- +title: Partner program landing page +--- + +Content coming soon. diff --git a/help/dub-partners/partners-with-groups.mdx b/help/dub-partners/partners-with-groups.mdx new file mode 100644 index 0000000..b3d9e2c --- /dev/null +++ b/help/dub-partners/partners-with-groups.mdx @@ -0,0 +1,5 @@ +--- +title: Partner groups +--- + +Content coming soon. diff --git a/help/dub-partners/program-bounties.mdx b/help/dub-partners/program-bounties.mdx new file mode 100644 index 0000000..ae4955e --- /dev/null +++ b/help/dub-partners/program-bounties.mdx @@ -0,0 +1,5 @@ +--- +title: Program bounties +--- + +Content coming soon. diff --git a/help/dub-partners/program-performance-analytics.mdx b/help/dub-partners/program-performance-analytics.mdx new file mode 100644 index 0000000..6a330bb --- /dev/null +++ b/help/dub-partners/program-performance-analytics.mdx @@ -0,0 +1,5 @@ +--- +title: Program performance analytics +--- + +Content coming soon. diff --git a/help/dub-partners/referral-links-partner-groups.mdx b/help/dub-partners/referral-links-partner-groups.mdx new file mode 100644 index 0000000..4ef308d --- /dev/null +++ b/help/dub-partners/referral-links-partner-groups.mdx @@ -0,0 +1,5 @@ +--- +title: Referral links by group +--- + +Content coming soon. diff --git a/help/dub-partners/reviewing-program-applications.mdx b/help/dub-partners/reviewing-program-applications.mdx new file mode 100644 index 0000000..9929192 --- /dev/null +++ b/help/dub-partners/reviewing-program-applications.mdx @@ -0,0 +1,5 @@ +--- +title: Reviewing applications +--- + +Content coming soon. diff --git a/help/dub-partners/sending-partner-payouts.mdx b/help/dub-partners/sending-partner-payouts.mdx new file mode 100644 index 0000000..ef205cd --- /dev/null +++ b/help/dub-partners/sending-partner-payouts.mdx @@ -0,0 +1,5 @@ +--- +title: Sending payouts +--- + +Content coming soon. diff --git a/help/dub-partners/setup-bank-account-payouts.mdx b/help/dub-partners/setup-bank-account-payouts.mdx new file mode 100644 index 0000000..3e26e16 --- /dev/null +++ b/help/dub-partners/setup-bank-account-payouts.mdx @@ -0,0 +1,5 @@ +--- +title: Payout bank accounts +--- + +Content coming soon. diff --git a/help/link-management/ab-testing.mdx b/help/link-management/ab-testing.mdx new file mode 100644 index 0000000..d1cdbc5 --- /dev/null +++ b/help/link-management/ab-testing.mdx @@ -0,0 +1,5 @@ +--- +title: A B testing +--- + +Content coming soon. diff --git a/help/link-management/add-utm-parameters.mdx b/help/link-management/add-utm-parameters.mdx new file mode 100644 index 0000000..b367d47 --- /dev/null +++ b/help/link-management/add-utm-parameters.mdx @@ -0,0 +1,5 @@ +--- +title: Adding UTM parameters +--- + +Content coming soon. diff --git a/help/link-management/bulk-link-management.mdx b/help/link-management/bulk-link-management.mdx new file mode 100644 index 0000000..02b3f4e --- /dev/null +++ b/help/link-management/bulk-link-management.mdx @@ -0,0 +1,5 @@ +--- +title: Bulk link management +--- + +Content coming soon. diff --git a/help/link-management/check-link-destination.mdx b/help/link-management/check-link-destination.mdx new file mode 100644 index 0000000..7c443e2 --- /dev/null +++ b/help/link-management/check-link-destination.mdx @@ -0,0 +1,5 @@ +--- +title: Previewing link destinations +--- + +Content coming soon. diff --git a/help/link-management/create-short-link.mdx b/help/link-management/create-short-link.mdx new file mode 100644 index 0000000..1ad810b --- /dev/null +++ b/help/link-management/create-short-link.mdx @@ -0,0 +1,5 @@ +--- +title: Creating short links +--- + +Content coming soon. diff --git a/help/link-management/custom-link-previews.mdx b/help/link-management/custom-link-previews.mdx new file mode 100644 index 0000000..57e760c --- /dev/null +++ b/help/link-management/custom-link-previews.mdx @@ -0,0 +1,5 @@ +--- +title: Custom link previews +--- + +Content coming soon. diff --git a/help/link-management/custom-qr-codes.mdx b/help/link-management/custom-qr-codes.mdx new file mode 100644 index 0000000..23dc2f8 --- /dev/null +++ b/help/link-management/custom-qr-codes.mdx @@ -0,0 +1,5 @@ +--- +title: Custom QR codes +--- + +Content coming soon. diff --git a/help/link-management/device-targeting.mdx b/help/link-management/device-targeting.mdx new file mode 100644 index 0000000..02596a5 --- /dev/null +++ b/help/link-management/device-targeting.mdx @@ -0,0 +1,5 @@ +--- +title: Device targeting +--- + +Content coming soon. diff --git a/help/link-management/double-redirects.mdx b/help/link-management/double-redirects.mdx new file mode 100644 index 0000000..c3af5a2 --- /dev/null +++ b/help/link-management/double-redirects.mdx @@ -0,0 +1,5 @@ +--- +title: Double redirects +--- + +Content coming soon. diff --git a/help/link-management/dubsh-links-not-working.mdx b/help/link-management/dubsh-links-not-working.mdx new file mode 100644 index 0000000..9becf8f --- /dev/null +++ b/help/link-management/dubsh-links-not-working.mdx @@ -0,0 +1,5 @@ +--- +title: Troubleshooting dub.sh links +--- + +Content coming soon. diff --git a/help/link-management/expiration-date.mdx b/help/link-management/expiration-date.mdx new file mode 100644 index 0000000..05ecba9 --- /dev/null +++ b/help/link-management/expiration-date.mdx @@ -0,0 +1,5 @@ +--- +title: Link expiration +--- + +Content coming soon. diff --git a/help/link-management/export-links.mdx b/help/link-management/export-links.mdx new file mode 100644 index 0000000..2dbf9ae --- /dev/null +++ b/help/link-management/export-links.mdx @@ -0,0 +1,5 @@ +--- +title: Exporting links +--- + +Content coming soon. diff --git a/help/link-management/folders-rbac.mdx b/help/link-management/folders-rbac.mdx new file mode 100644 index 0000000..dcd2f20 --- /dev/null +++ b/help/link-management/folders-rbac.mdx @@ -0,0 +1,71 @@ +--- +title: Folder access control +description: "Learn how to set role-based access control for your folders to limit access to links for select teammates." +--- + +This feature is only available for [Business plans and above](https://dub.co/pricing). + +With folders, you can limit access to your links using fine-grained role-based access controls (RBAC). + +E.g. if you have marketing teams from different departments within your Dub workspace, you can create folders for each team with role-based access controls to ensure members can only see the links that they should have access to. + +![Folders RBAC](https://assets.dub.co/cms/folders-rbac.png) + +In this guide, we will learn how to set role-based access control for your folders to limit access to links for select teammates. + +## What is role-based access control (RBAC)? + +Role-based access control (RBAC) is a security approach that restricts access to resources based on the roles of individual users. Think of it like a modern office building where different employees have access to different floors based on their job roles. + +In Dub's link folders, RBAC lets you control who can access specific folders and what they can do with the links inside them. For example, marketing team members might only have access to the "Marketing Campaigns" folder, while team leads have full access to all folders. + +This granular control ensures that sensitive links remain secure while still allowing teams to collaborate effectively within their designated areas. + +## Workspace-level permissions + +When you create a folder, you can decide what the workspace-level permissions are for the folder. Workspace owners have access and full permissions to every created folder. + +![Create new folder access](https://assets.dub.co/cms/create-new-folder-access.png) + + +There are 3 options for the workspace-level permissions: + +1. **Can edit** (default): Anyone in the workspace can access the folder and its links. +2. **Can view** (view-only): Workspace members can view the folder and its links, but not edit them. +3. **No access** (private folder): Only members added to the folder and workspace owners have access (via folder-level permissions). + +If you're on the [Pro plan](https://dub.co/pricing), you can only create folders with the default "Can edit" settings. Only [Business plan](https://dub.co/pricing) and above users can create folders with the "Can view" or "No access" settings. + + +## Folder-level permissions + +You can also set folder-level permissions for each folder. This lets you set exactly which members can access the folder and what they can do with the links inside it. + +To set folder-level permissions, open the ⋮ dropdown next to the folder in your links dashboard and select the "Members" option: + +![Folders member option](https://assets.dub.co/cms/folders-action-member-option.png) + +This will open up the member access control panel, where you can set different roles to different users: + +![Folders member option](https://assets.dub.co/cms/folder-members-rbac.png) + + +| Role | Description | +| --- | --- | +| Owner | Has full access to the folder and its links.
Can also invite other members to the folder / manage their access levels. | +| Editor | Can edit the folder and its links. | +| Viewer | Can view the folder and its links. | +| No access | Cannot view the folder and its links. | + + +If you are using [machine users](https://dub.co/docs/api-reference/tokens#machine-users) for your API/integrations, remember to assign them the correct folder permissions as well – they function the same way as regular users and would require the correct permissions to be able to perform actions within a folder. + +## Requesting access to a folder + +If you only have read access to a folder, you can request edit access by clicking on the "Ask to edit" button: + +![Request edit access folder](https://assets.dub.co/cms/request-edit-folder.png) + +This will send an email to the folder admin, who can then grant edit/owner access to you to manage the folder and its links: + +![Folder access request email](https://assets.dub.co/cms/folder-access-request-email.png) diff --git a/help/link-management/geo-targeting.mdx b/help/link-management/geo-targeting.mdx new file mode 100644 index 0000000..b3bde3a --- /dev/null +++ b/help/link-management/geo-targeting.mdx @@ -0,0 +1,5 @@ +--- +title: Geo targeting +--- + +Content coming soon. diff --git a/help/link-management/link-builder.mdx b/help/link-management/link-builder.mdx new file mode 100644 index 0000000..4e9ccfa --- /dev/null +++ b/help/link-management/link-builder.mdx @@ -0,0 +1,5 @@ +--- +title: Link builder overview +--- + +Content coming soon. diff --git a/help/link-management/link-cloaking.mdx b/help/link-management/link-cloaking.mdx new file mode 100644 index 0000000..2aa218b --- /dev/null +++ b/help/link-management/link-cloaking.mdx @@ -0,0 +1,5 @@ +--- +title: Link cloaking +--- + +Content coming soon. diff --git a/help/link-management/link-comments.mdx b/help/link-management/link-comments.mdx new file mode 100644 index 0000000..98aaff5 --- /dev/null +++ b/help/link-management/link-comments.mdx @@ -0,0 +1,5 @@ +--- +title: Link comments +--- + +Content coming soon. diff --git a/help/link-management/links-with-folders.mdx b/help/link-management/links-with-folders.mdx new file mode 100644 index 0000000..834591c --- /dev/null +++ b/help/link-management/links-with-folders.mdx @@ -0,0 +1,5 @@ +--- +title: Link folders +--- + +Content coming soon. diff --git a/help/link-management/noindex.mdx b/help/link-management/noindex.mdx new file mode 100644 index 0000000..fe32692 --- /dev/null +++ b/help/link-management/noindex.mdx @@ -0,0 +1,5 @@ +--- +title: Noindex behavior +--- + +Content coming soon. diff --git a/help/link-management/pass-query-parameters.mdx b/help/link-management/pass-query-parameters.mdx new file mode 100644 index 0000000..04b92ec --- /dev/null +++ b/help/link-management/pass-query-parameters.mdx @@ -0,0 +1,5 @@ +--- +title: Passing query parameters +--- + +Content coming soon. diff --git a/help/link-management/password-protected-links.mdx b/help/link-management/password-protected-links.mdx new file mode 100644 index 0000000..30302be --- /dev/null +++ b/help/link-management/password-protected-links.mdx @@ -0,0 +1,5 @@ +--- +title: Password protected links +--- + +Content coming soon. diff --git a/help/link-management/tags.mdx b/help/link-management/tags.mdx new file mode 100644 index 0000000..829da48 --- /dev/null +++ b/help/link-management/tags.mdx @@ -0,0 +1,5 @@ +--- +title: How to use Tags on Dub +--- + +Content coming soon. diff --git a/help/link-management/transfer-links-between-workspaces.mdx b/help/link-management/transfer-links-between-workspaces.mdx new file mode 100644 index 0000000..a1d2adf --- /dev/null +++ b/help/link-management/transfer-links-between-workspaces.mdx @@ -0,0 +1,5 @@ +--- +title: Transferring links between workspaces +--- + +Content coming soon. diff --git a/help/link-management/utm-templates.mdx b/help/link-management/utm-templates.mdx new file mode 100644 index 0000000..46273ad --- /dev/null +++ b/help/link-management/utm-templates.mdx @@ -0,0 +1,5 @@ +--- +title: UTM templates +--- + +Content coming soon. diff --git a/help/migrating-to-dub/bitly.mdx b/help/migrating-to-dub/bitly.mdx new file mode 100644 index 0000000..b5f8e20 --- /dev/null +++ b/help/migrating-to-dub/bitly.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from Bitly +--- + +Content coming soon. diff --git a/help/migrating-to-dub/firstpromoter.mdx b/help/migrating-to-dub/firstpromoter.mdx new file mode 100644 index 0000000..71db0a0 --- /dev/null +++ b/help/migrating-to-dub/firstpromoter.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from FirstPromoter +--- + +Content coming soon. diff --git a/help/migrating-to-dub/partnerstack.mdx b/help/migrating-to-dub/partnerstack.mdx new file mode 100644 index 0000000..dbda0bc --- /dev/null +++ b/help/migrating-to-dub/partnerstack.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from PartnerStack +--- + +Content coming soon. diff --git a/help/migrating-to-dub/rebrandly.mdx b/help/migrating-to-dub/rebrandly.mdx new file mode 100644 index 0000000..ee80aa4 --- /dev/null +++ b/help/migrating-to-dub/rebrandly.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from Rebrandly +--- + +Content coming soon. diff --git a/help/migrating-to-dub/rewardful.mdx b/help/migrating-to-dub/rewardful.mdx new file mode 100644 index 0000000..d107a6d --- /dev/null +++ b/help/migrating-to-dub/rewardful.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from Rewardful +--- + +Content coming soon. diff --git a/help/migrating-to-dub/short-io.mdx b/help/migrating-to-dub/short-io.mdx new file mode 100644 index 0000000..f450328 --- /dev/null +++ b/help/migrating-to-dub/short-io.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from Short.io +--- + +Content coming soon. diff --git a/help/migrating-to-dub/tolt.mdx b/help/migrating-to-dub/tolt.mdx new file mode 100644 index 0000000..715e46e --- /dev/null +++ b/help/migrating-to-dub/tolt.mdx @@ -0,0 +1,5 @@ +--- +title: Migrating from Tolt +--- + +Content coming soon. diff --git a/help/overview.mdx b/help/overview.mdx new file mode 100644 index 0000000..d2adc04 --- /dev/null +++ b/help/overview.mdx @@ -0,0 +1,15 @@ +--- +title: Getting Started +--- + +Image for sure + +Content coming soon. + +What is Dub? + +Common links + +Jumping points to Dub Links and Dub Partners + +Links to Documention (new name soon) and APIs diff --git a/help/partnering-with-programs/commissions-and-payouts.mdx b/help/partnering-with-programs/commissions-and-payouts.mdx new file mode 100644 index 0000000..a69cb39 --- /dev/null +++ b/help/partnering-with-programs/commissions-and-payouts.mdx @@ -0,0 +1,5 @@ +--- +title: How commissions and payouts work +--- + +Content coming soon. diff --git a/help/partnering-with-programs/communicating-with-programs.mdx b/help/partnering-with-programs/communicating-with-programs.mdx new file mode 100644 index 0000000..40ead7e --- /dev/null +++ b/help/partnering-with-programs/communicating-with-programs.mdx @@ -0,0 +1,5 @@ +--- +title: Communicating with programs +--- + +Content coming soon. diff --git a/help/partnering-with-programs/faq.mdx b/help/partnering-with-programs/faq.mdx new file mode 100644 index 0000000..973658f --- /dev/null +++ b/help/partnering-with-programs/faq.mdx @@ -0,0 +1,5 @@ +--- +title: Partner FAQs +--- + +Content coming soon. diff --git a/help/partnering-with-programs/joining-programs-marketplace.mdx b/help/partnering-with-programs/joining-programs-marketplace.mdx new file mode 100644 index 0000000..ef079df --- /dev/null +++ b/help/partnering-with-programs/joining-programs-marketplace.mdx @@ -0,0 +1,5 @@ +--- +title: Joining programs from the marketplace +--- + +Content coming soon. diff --git a/help/partnering-with-programs/managing-partner-teams.mdx b/help/partnering-with-programs/managing-partner-teams.mdx new file mode 100644 index 0000000..615c861 --- /dev/null +++ b/help/partnering-with-programs/managing-partner-teams.mdx @@ -0,0 +1,5 @@ +--- +title: Partner teams +--- + +Content coming soon. diff --git a/help/partnering-with-programs/merging-partner-accounts.mdx b/help/partnering-with-programs/merging-partner-accounts.mdx new file mode 100644 index 0000000..ff7fdb6 --- /dev/null +++ b/help/partnering-with-programs/merging-partner-accounts.mdx @@ -0,0 +1,5 @@ +--- +title: Merging partner accounts +--- + +Content coming soon. diff --git a/help/partnering-with-programs/navigating-partner-program.mdx b/help/partnering-with-programs/navigating-partner-program.mdx new file mode 100644 index 0000000..ca93608 --- /dev/null +++ b/help/partnering-with-programs/navigating-partner-program.mdx @@ -0,0 +1,5 @@ +--- +title: Partner program overview +--- + +Content coming soon. diff --git a/help/partnering-with-programs/receiving-partner-payouts.mdx b/help/partnering-with-programs/receiving-partner-payouts.mdx new file mode 100644 index 0000000..bcd6c79 --- /dev/null +++ b/help/partnering-with-programs/receiving-partner-payouts.mdx @@ -0,0 +1,5 @@ +--- +title: Receiving payouts +--- + +Content coming soon. diff --git a/help/partnering-with-programs/setting-business-details-in-payout-invoices.mdx b/help/partnering-with-programs/setting-business-details-in-payout-invoices.mdx new file mode 100644 index 0000000..d0c0e52 --- /dev/null +++ b/help/partnering-with-programs/setting-business-details-in-payout-invoices.mdx @@ -0,0 +1,5 @@ +--- +title: Payout invoice details +--- + +Content coming soon. diff --git a/help/partnering-with-programs/updating-partner-profile.mdx b/help/partnering-with-programs/updating-partner-profile.mdx new file mode 100644 index 0000000..d621e6d --- /dev/null +++ b/help/partnering-with-programs/updating-partner-profile.mdx @@ -0,0 +1,5 @@ +--- +title: Managing your partner profile +--- + +Content coming soon. diff --git a/help/saml-sso/azure-ad.mdx b/help/saml-sso/azure-ad.mdx new file mode 100644 index 0000000..0a9989f --- /dev/null +++ b/help/saml-sso/azure-ad.mdx @@ -0,0 +1,5 @@ +--- +title: Azure AD SAML setup +--- + +Content coming soon. diff --git a/help/saml-sso/google-workspace.mdx b/help/saml-sso/google-workspace.mdx new file mode 100644 index 0000000..41ebc20 --- /dev/null +++ b/help/saml-sso/google-workspace.mdx @@ -0,0 +1,5 @@ +--- +title: Google Workspace SAML setup +--- + +Content coming soon. diff --git a/help/saml-sso/okta.mdx b/help/saml-sso/okta.mdx new file mode 100644 index 0000000..e6a9210 --- /dev/null +++ b/help/saml-sso/okta.mdx @@ -0,0 +1,5 @@ +--- +title: Okta SAML setup +--- + +Content coming soon. diff --git a/help/saml-sso/scim-azure-ad.mdx b/help/saml-sso/scim-azure-ad.mdx new file mode 100644 index 0000000..14bcd5e --- /dev/null +++ b/help/saml-sso/scim-azure-ad.mdx @@ -0,0 +1,5 @@ +--- +title: Azure AD SCIM setup +--- + +Content coming soon. diff --git a/help/saml-sso/scim-okta.mdx b/help/saml-sso/scim-okta.mdx new file mode 100644 index 0000000..0ce807a --- /dev/null +++ b/help/saml-sso/scim-okta.mdx @@ -0,0 +1,5 @@ +--- +title: Okta SCIM setup +--- + +Content coming soon. diff --git a/help/workspace-management.mdx b/help/workspace-management.mdx new file mode 100644 index 0000000..94560c4 --- /dev/null +++ b/help/workspace-management.mdx @@ -0,0 +1,5 @@ +--- +title: Workspace Management +--- + +Content coming soon. diff --git a/help/workspace-management/automation-and-logs.mdx b/help/workspace-management/automation-and-logs.mdx new file mode 100644 index 0000000..8334576 --- /dev/null +++ b/help/workspace-management/automation-and-logs.mdx @@ -0,0 +1,5 @@ +--- +title: Automation and logs +--- + +Content coming soon. diff --git a/help/workspace-management/billing-and-plans.mdx b/help/workspace-management/billing-and-plans.mdx new file mode 100644 index 0000000..14bb5c8 --- /dev/null +++ b/help/workspace-management/billing-and-plans.mdx @@ -0,0 +1,5 @@ +--- +title: Billing and plans +--- + +Content coming soon. diff --git a/help/workspace-management/cancel-subscription.mdx b/help/workspace-management/cancel-subscription.mdx new file mode 100644 index 0000000..82c05eb --- /dev/null +++ b/help/workspace-management/cancel-subscription.mdx @@ -0,0 +1,5 @@ +--- +title: Canceling a subscription +--- + +Content coming soon. diff --git a/help/workspace-management/change-billing-information.mdx b/help/workspace-management/change-billing-information.mdx new file mode 100644 index 0000000..3b0b712 --- /dev/null +++ b/help/workspace-management/change-billing-information.mdx @@ -0,0 +1,5 @@ +--- +title: Updating billing information +--- + +Content coming soon. diff --git a/help/workspace-management/download-invoice.mdx b/help/workspace-management/download-invoice.mdx new file mode 100644 index 0000000..a87cb06 --- /dev/null +++ b/help/workspace-management/download-invoice.mdx @@ -0,0 +1,5 @@ +--- +title: Downloading invoices +--- + +Content coming soon. diff --git a/help/workspace-management/invite-teammates.mdx b/help/workspace-management/invite-teammates.mdx new file mode 100644 index 0000000..9ea4dd1 --- /dev/null +++ b/help/workspace-management/invite-teammates.mdx @@ -0,0 +1,5 @@ +--- +title: Inviting team members +--- + +Content coming soon. diff --git a/help/workspace-management/manage-member-roles.mdx b/help/workspace-management/manage-member-roles.mdx new file mode 100644 index 0000000..40d35eb --- /dev/null +++ b/help/workspace-management/manage-member-roles.mdx @@ -0,0 +1,5 @@ +--- +title: Roles and permissions +--- + +Content coming soon. diff --git a/help/workspace-management/usage-limits.mdx b/help/workspace-management/usage-limits.mdx new file mode 100644 index 0000000..2626325 --- /dev/null +++ b/help/workspace-management/usage-limits.mdx @@ -0,0 +1,5 @@ +--- +title: Usage limits +--- + +Content coming soon. diff --git a/help/workspace-management/what-is-a-workspace.mdx b/help/workspace-management/what-is-a-workspace.mdx new file mode 100644 index 0000000..2f44c39 --- /dev/null +++ b/help/workspace-management/what-is-a-workspace.mdx @@ -0,0 +1,5 @@ +--- +title: Overview +--- + +Content coming soon.