Skip to content

Commit 46abc20

Browse files
Docs plus plan (#68154)
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent 4a0ad0a commit 46abc20

File tree

4 files changed

+84
-54
lines changed

4 files changed

+84
-54
lines changed

docs/community/contributing-to-airbyte/writing-docs.md

Lines changed: 37 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The [Good Docs Project](https://www.thegooddocsproject.dev/) maintains a collect
148148
| --------------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
149149
| Concept | Explain a concept, context, or background information about a product or its features. | [Template](https://gitlab.com/tgdp/templates/-/tree/main/concept) |
150150
| How-to | A concise set of numbered steps to do one task with the product. | [Template](https://gitlab.com/tgdp/templates/-/tree/main/how-to) |
151-
| Tutorial | Instructions to set up an example project intended for hands-on learning. | [Template](https://gitlab.com/tgdp/templates/-/tree/main/tutorial) |
151+
| Tutorial | Instructions to set up an example project intended for hands-on learning. | [Template](https://gitlab.com/tgdp/templates/-/tree/main/tutorial) |
152152
| Troubleshooting | Common problems experienced by users, an explanation of the causes, and steps to resolve the issue. | [Template](https://gitlab.com/tgdp/templates/-/tree/main/troubleshooting) |
153153
| Reference | Specific, in-depth details about a particular topic. | [Template](https://gitlab.com/tgdp/templates/-/tree/main/reference) |
154154
| Release note | Communicate new features, improvements, bug fixes, and known issues about a product. | [Template](https://gitlab.com/tgdp/templates/-/tree/main/release-notes) |
@@ -218,22 +218,22 @@ Certain Airbyte products reserve some platform features. To avoid confusion and
218218

219219
To enable badges, include `products` in the Markdown metadata. The following values are possible, and you can combine them as needed.
220220

221-
**Badge display:** all 5 badges always appear in order - Core, Standard, Pro, Enterprise Flex, Self-Managed Enterprise. Available badges appear highlighted, unavailable badges appear grayed out.
221+
**Badge display:** all 6 badges always appear in order - Core, Standard, Plus, Pro, Enterprise Flex, Self-Managed Enterprise. Available badges appear highlighted, unavailable badges appear grayed out.
222222

223223
**Metadata keys:**
224224

225-
- `all`: Core, Self-Managed Enterprise, and Standard - doesn't include Pro, Enterprise Flex, or Embedded
225+
- `all`: Core, Self-Managed Enterprise, Standard, and Plus - doesn't include Pro, Enterprise Flex, or Embedded
226226
- `oss-community`: Core only
227227
- `oss-enterprise`: Self-Managed Enterprise only
228-
- `cloud`: Standard only (also enables Pro and Enterprise Flex due to Cloud tier inheritance)
228+
- `cloud`: Standard and Plus (also enables Pro and Enterprise Flex due to Cloud tier inheritance)
229229
- `cloud-teams`: Pro only (also enables Enterprise Flex due to Cloud tier inheritance)
230230
- `enterprise-flex`: Enterprise Flex only
231231
- `embedded`: Embedded only (hidden if not specified - there is no off state for the Embedded badge)
232232

233233
**Cloud tier inheritance:** higher Cloud plans automatically inherit availability from lower tiers:
234234

235-
- If you specify `cloud`: Standard, Pro, and Enterprise Flex badges all become enabled
236-
- If you specify `cloud-teams`: Pro and Enterprise Flex badges become enabled - Standard turns off
235+
- If you specify `cloud`: Standard, Plus, Pro, and Enterprise Flex badges all become enabled
236+
- If you specify `cloud-teams`: Pro and Enterprise Flex badges become enabled - Standard and Plus turn off
237237
- If you specify `enterprise-flex`: Only Enterprise Flex badge becomes enabled
238238

239239
**Self-managed plans** Core and Self-Managed Enterprise don't inherit from each other.
@@ -250,7 +250,7 @@ products: oss-community
250250
Some text.
251251
```
252252

253-
In this example, Pro, and Enterprise Flex badges appear highlighted due to Cloud tier inheritance, while Core, Standard, and Self-Managed Enterprise badges appear grayed out.
253+
In this example, Pro, and Enterprise Flex badges appear highlighted due to Cloud tier inheritance, while Core, Standard, Plus, and Self-Managed Enterprise badges appear grayed out.
254254

255255
```markdown
256256
---
@@ -408,18 +408,17 @@ You can run Vale in a command line tool or you can install an extension for most
408408
```
409409

410410
2. Lint your content. You can lint a single file or an entire directory and its subdirectories.
411-
412411
- To lint a file, type the relative path to the file.
413412

414-
```bash
415-
vale ../docs/myfolder/myfile.md
416-
```
413+
```bash
414+
vale ../docs/myfolder/myfile.md
415+
```
417416

418417
- To lint a folder, type the relative path to that folder and end with a slash.
419418

420-
```bash
421-
vale ../docs/myfolder/
422-
```
419+
```bash
420+
vale ../docs/myfolder/
421+
```
423422

424423
- For more command-line tool help, see [Vale's docs](https://vale.sh/docs/cli).
425424
@@ -445,29 +444,29 @@ brew install markdownlint-cli2
445444

446445
To lint files:
447446

448-
- To lint a single file:
447+
- To lint a single file:
449448

450-
```bash
451-
markdownlint-cli2 "./docs/myfolder/myfile.md"
452-
```
449+
```bash
450+
markdownlint-cli2 "./docs/myfolder/myfile.md"
451+
```
453452

454-
- To lint a single directory but not its subdirectories:
453+
- To lint a single directory but not its subdirectories:
455454

456-
```bash
457-
markdownlint-cli2 "./docs/myfolder/*.md"
458-
```
455+
```bash
456+
markdownlint-cli2 "./docs/myfolder/*.md"
457+
```
459458

460-
- To lint a directory and its subdirectories recursively:
459+
- To lint a directory and its subdirectories recursively:
461460

462-
```bash
463-
markdownlint-cli2 "./docs/folder/**/*.md"
464-
```
461+
```bash
462+
markdownlint-cli2 "./docs/folder/**/*.md"
463+
```
465464

466-
- To auto-fix issues, add a `--fix` modifier. MarkDownLint can fix most issues on its own, but it might not fix them all.
465+
- To auto-fix issues, add a `--fix` modifier. MarkDownLint can fix most issues on its own, but it might not fix them all.
467466

468-
```bash
469-
markdownlint-cli2 --fix "../docs/myfolder/*.md"
470-
```
467+
```bash
468+
markdownlint-cli2 --fix "../docs/myfolder/*.md"
469+
```
471470

472471
For full usage details, see the tool's [GitHub readme](https://github.com/DavidAnson/markdownlint-cli2?tab=readme-ov-file#use).
473472
@@ -525,19 +524,17 @@ When you release a new major version of Airbyte like 2.0 or 2.1, generate a docu
525524
526525
2. Open a terminal, change to the docusaurus folder, and run the command to generate a version. `<version>` can be a number like `2.0` or anything else you like. Be consistent with Airbyte and other versions on the docs site. Whatever string you enter here later appears in the docs UI.
527526
528-
```bash
529-
cd docusaurus
530-
pnpm run docusaurus docs:version:platform <version>
531-
```
532-
533-
Docusaurus automatically does three things at this point. It:
527+
```bash
528+
cd docusaurus
529+
pnpm run docusaurus docs:version:platform <version>
530+
```
534531
535-
- Defines the existence of that version in the `/docusaurus/platform_versions.json` file
536-
- Creates a physical copy of the versioned platform docs in `/docusaurus/platform_versioned_docs`
537-
- Creates a physical copy of the versioned platform sidebar in `/docusaurus/platform_versioned_sidebars`
532+
Docusaurus automatically does three things at this point. It:
533+
- Defines the existence of that version in the `/docusaurus/platform_versions.json` file
534+
- Creates a physical copy of the versioned platform docs in `/docusaurus/platform_versioned_docs`
535+
- Creates a physical copy of the versioned platform sidebar in `/docusaurus/platform_versioned_sidebars`
538536
539537
3. Test your build locally to make sure everything looks as expected. Verify:
540-
541538
- The docs site builds locally
542539
- Your local Docusaurus build doesn't report new broken links
543540
- The version selector in the navigation contains your new version

docs/platform/readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,12 @@ Airbyte is available as a self-managed, hybrid, or fully managed cloud solution.
2727

2828
### Cloud and hybrid plans
2929

30-
<Grid columns="3">
30+
<Grid columns="2">
3131

3232
<CardWithIcon title="Standard" description="A cloud solution that provides a fully managed experience for data replication. Focus on moving data while Airbyte manages the infrastructure. Free 30-day trial." ctaText="Sign up" ctaLink="https://cloud.airbyte.com/signup" icon="fa-cloud" />
3333

34+
<CardWithIcon title="Plus" description="A cloud solution with all the capabilities of Standard, plus higher priority support and predictable, capacity-based annual pricing." ctaText="Talk to Sales" ctaLink="https://airbyte.com/company/talk-to-sales" icon="fa-lock" />
35+
3436
<CardWithIcon title="Pro" description="A cloud solution for organizations looking to scale efficiently. Role based access control, single sign on, and more ensure Pro is a robust solution that can grow with your team." ctaText="Talk to Sales" ctaLink="https://airbyte.com/company/talk-to-sales" icon="fa-lock" />
3537

3638
<CardWithIcon title="Enterprise Flex" description="An enterprise-grade, hybrid solution with for organizatons seeking the convenience of a fully managed solution with separate data planes for compliance and data sovereignty." ctaText="Learn more" ctaLink="enterprise-flex" icon="fa-lock" />
@@ -43,7 +45,7 @@ Once your Airbyte instance is up and running, there's a way to use Airbyte that'
4345

4446
### User interface
4547

46-
Self-managed and cloud plans come with a carefully-crafted user interface that walks you through setting up connections and automating syncs. This is a great choice if you're not a developer, aren't concerned about version control, or you're just seeing what Airbyte can do for you.
48+
Self-managed and cloud plans come with a carefully crafted user interface that walks you through setting up connections and automating syncs. This is a great choice if you're not a developer, aren't concerned about version control, or you're just seeing what Airbyte can do for you.
4749

4850
### API and Python SDK {#api-sdk}
4951

docusaurus/src/components/HeaderDecoration.jsx

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -261,14 +261,30 @@ const ConnectorMetadataCallout = ({
261261
<Chip className={isCloud ? styles.available : styles.unavailable}>
262262
<EnabledIcon isEnabled={isCloud} /> Standard
263263
</Chip>
264-
<Chip className={isEnterprise || isCloud ? styles.available : styles.unavailable}>
264+
<Chip className={isCloud ? styles.available : styles.unavailable}>
265+
<EnabledIcon isEnabled={isCloud} /> Plus
266+
</Chip>
267+
<Chip
268+
className={
269+
isEnterprise || isCloud ? styles.available : styles.unavailable
270+
}
271+
>
265272
<EnabledIcon isEnabled={isEnterprise || isCloud} /> Pro
266273
</Chip>
267-
<Chip className={isEnterprise || isCloud ? styles.available : styles.unavailable}>
274+
<Chip
275+
className={
276+
isEnterprise || isCloud ? styles.available : styles.unavailable
277+
}
278+
>
268279
<EnabledIcon isEnabled={isEnterprise || isCloud} /> Enterprise Flex
269280
</Chip>
270-
<Chip className={isEnterprise || isOss ? styles.available : styles.unavailable}>
271-
<EnabledIcon isEnabled={isEnterprise || isOss} /> Self-Managed Enterprise
281+
<Chip
282+
className={
283+
isEnterprise || isOss ? styles.available : styles.unavailable
284+
}
285+
>
286+
<EnabledIcon isEnabled={isEnterprise || isOss} /> Self-Managed
287+
Enterprise
272288
</Chip>
273289
<Chip className={isOss ? styles.available : styles.unavailable}>
274290
<EnabledIcon isEnabled={isOss} /> PyAirbyte
@@ -334,7 +350,12 @@ const ConnectorMetadataCallout = ({
334350
</Callout>
335351
);
336352

337-
const ConnectorTitle = ({ iconUrl, originalTitle, isArchived, enterpriseConnector }) => (
353+
const ConnectorTitle = ({
354+
iconUrl,
355+
originalTitle,
356+
isArchived,
357+
enterpriseConnector,
358+
}) => (
338359
<div className={styles.header}>
339360
<img src={iconUrl} alt="" className={styles.connectorIcon} />
340361
<h1 data-enterprise-connector={enterpriseConnector}>
@@ -375,9 +396,7 @@ export const HeaderDecoration = ({
375396

376397
return (
377398
<>
378-
<div
379-
className={styles.connectorHeader}
380-
>
399+
<div className={styles.connectorHeader}>
381400
<ConnectorTitle
382401
iconUrl={iconUrl}
383402
originalTitle={originalTitle}

docusaurus/src/components/ProductInformation.jsx

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,22 @@ export const ProductInformation = ({ products }) => {
4444

4545
return (
4646
<div className={styles.badges}>
47-
<Badge available={ossCommunity} title="Formerly Self-Managed Community">Core</Badge>
48-
<Badge available={cloud && !cloudTeams && !enterpriseFlex} title="Formerly Cloud">Standard</Badge>
49-
<Badge available={cloud || cloudTeams} title="Formerly Cloud Teams">Pro</Badge>
50-
<Badge available={cloud || cloudTeams || enterpriseFlex}>Enterprise Flex</Badge>
47+
<Badge available={ossCommunity} title="Formerly Self-Managed Community">
48+
Core
49+
</Badge>
50+
<Badge
51+
available={cloud && !cloudTeams && !enterpriseFlex}
52+
title="Formerly Cloud"
53+
>
54+
Standard
55+
</Badge>
56+
<Badge available={cloud && !cloudTeams && !enterpriseFlex}>Plus</Badge>
57+
<Badge available={cloud || cloudTeams} title="Formerly Cloud Teams">
58+
Pro
59+
</Badge>
60+
<Badge available={cloud || cloudTeams || enterpriseFlex}>
61+
Enterprise Flex
62+
</Badge>
5163
<Badge available={ossEnterprise}>Self-Managed Enterprise</Badge>
5264
{embedded && <Badge available={true}>Embedded</Badge>}
5365
<a

0 commit comments

Comments
 (0)