Skip to content

Commit

Permalink
fix the MDX issues
Browse files Browse the repository at this point in the history
  • Loading branch information
lmouhib committed Jul 1, 2024
1 parent b735538 commit 6955d93
Show file tree
Hide file tree
Showing 23 changed files with 69 additions and 169 deletions.
6 changes: 3 additions & 3 deletions framework/generate_doc.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,6 @@ for (let key in snippets) {
${typescript}
\`\`\`
\`\`\`mdx-code-block
</TabItem>
<TabItem value="python" label="Python">
Expand Down Expand Up @@ -92,7 +90,9 @@ for (let module in fullReadme) {
let constructReadmeLines = constructReadme.split('\n');
constructReadmeLines.shift(); // remove title
constructReadme = constructReadmeLines.join('\n');
constructReadme = `[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/${module})
constructReadme = `<!-- This file is generated, do not modify directly, update the README.md in framework/src/${module} -->
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
${constructReadme}`;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/consumption)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/consumption -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand All @@ -24,8 +26,6 @@ new dsf.consumption.AthenaWorkGroup(this, 'AthenaWorkGroupDefault', {
})
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -63,8 +63,6 @@ new dsf.consumption.AthenaWorkGroup(this, 'AthenaWorkGroupDefault', {
})
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -104,8 +102,6 @@ You can access the execution role via `executionRole` property.
})
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -139,8 +135,6 @@ new dsf.consumption.AthenaWorkGroup(this, 'AthenaWorkGroupProperties', {
})
```

```mdx-code-block

</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -173,8 +167,6 @@ We provide `grantRunQueries` method to grant permission to principals to run que
athenaWg.grantRunQueries(athenaExampleRole)
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/consumption)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/consumption -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -57,8 +59,6 @@ const osCluster = new dsf.consumption.OpenSearchCluster(this, 'MyOpenSearchClust
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -100,8 +100,6 @@ const osCluster = new dsf.consumption.OpenSearchCluster(this, 'MyOpenSearchClust
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/consumption)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/consumption -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -64,8 +66,6 @@ class ExampleRedshiftDataSharingSameAccountStack extends Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -173,8 +173,6 @@ class ExampleRedshiftDataSharingCrossAccountBStack extends Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/consumption)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/consumption -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -29,8 +31,6 @@ class ExampleDefaultRedshiftServerlessNamespaceStack extends Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -84,8 +84,6 @@ class ExampleRedshiftServerlessNamespaceRolesStack extends Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/consumption)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/consumption -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -33,8 +35,6 @@ class ExampleDefaultRedshiftServerlessWorkgroupStack extends Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -108,8 +108,6 @@ The `RedshiftData` construct provides the following helpers for bootstrapping Re
dbSchema.node.addDependency(dbRole);
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -179,8 +177,6 @@ class ExampleRedshiftServerlessWorkgroupCatalogStack extends Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/governance)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/governance -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -37,8 +39,6 @@ class ExampleDefaultDataCatalogDatabaseStack extends cdk.Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -84,8 +84,6 @@ You can change the default configuration of the AWS Glue Crawler to match your r
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/governance)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/governance -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -35,8 +37,6 @@ class ExampleDefaultDataLakeCatalogStack extends cdk.Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -80,8 +80,6 @@ The parameters apply to the three databases, if you need fine-grained configurat
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/processing)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/processing -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -78,8 +80,6 @@ new dsf.processing.PySparkApplicationPackage(this, 'PySparkApplicationPackage',
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -153,8 +153,6 @@ The stack below leverages the resources defined above for PySpark to build the e
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/processing)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/processing -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -81,8 +83,6 @@ export class EmrApplicationStack extends cdk.Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -122,8 +122,6 @@ export class CICDPipelineStack extends cdk.Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -210,8 +208,6 @@ export class EmrApplicationStack extends cdk.Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -258,8 +254,6 @@ new dsf.processing.SparkEmrCICDPipeline(this, 'SparkCICDPipeline', {
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/processing)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/processing -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -88,8 +90,6 @@ class ExampleSparkEmrContainersStack extends cdk.Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -199,8 +199,6 @@ The method configures the right Kubernetes RBAC as described [here](https://docs
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -255,8 +253,6 @@ The usage example below shows how to provide these as CloudFormation output. The
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -313,8 +309,6 @@ The execution role is the IAM role that is used by the Spark job to access AWS r
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -369,8 +363,6 @@ The interactive endpoint provides the capability for interactive clients like Am
});
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down Expand Up @@ -450,8 +442,6 @@ The Grant Job Execution allow you to provide an IAM role the rights to start the
SparkEmrContainersRuntime.grantStartJobExecution(startJobRole, [execRole.roleArn], virtualCluster.attrArn);
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[//]: # (This file is generated, do not modify directly, update the README.md in framework/src/processing)
<!-- This file is generated, do not modify directly, update the README.md in framework/src/processing -->


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -71,8 +73,6 @@ class ExampleSparkEmrServerlessStack extends cdk.Stack {
}
```

```mdx-code-block
</TabItem>
<TabItem value="python" label="Python">

Expand Down
Loading

0 comments on commit 6955d93

Please sign in to comment.