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.

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

docs: add Lake Formation docs #94

Merged
merged 5 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,6 @@ dlz.DataLandingZone(app,
)
),
)
app.synth()
```

Continue reading [Getting Started](https://datalandingzone.com/getting-started/) on the DLZ documentation site.
Expand Down
2 changes: 1 addition & 1 deletion docs/.astro/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"_variables": {
"lastUpdateCheck": 1733234760976
"lastUpdateCheck": 1733326685860
}
}
30 changes: 16 additions & 14 deletions docs/astro.config.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import { defineConfig } from 'astro/config';
import rehypeMermaid from "rehype-mermaid";
import starlightImageZoom from 'starlight-image-zoom'
import starlightImageZoom from 'starlight-image-zoom';

let site: string;
if (process.env.CF_PAGES_BRANCH) {
Expand All @@ -26,7 +26,7 @@ export default defineConfig({
Footer: './src/components/Footer.astro',
},
social: {
github: 'https://github.com/withastro/starlight', //TODO
github: 'https://github.com/DataChefHQ/aws-data-landing-zone',
},
sidebar: [
{
Expand Down Expand Up @@ -92,20 +92,21 @@ export default defineConfig({
// { label: 'Iam Identity Center', slug: 'introduction'},
// ]
// },
// {
// label: 'Data Services',
// items: [
// { label: 'Overview', slug: 'introduction'},
// { label: 'LakeFormation', slug: 'introduction'},
// ]
// },
{
label: 'Data Services',
items: [
{
label: 'Lake Formation', slug: 'components/data-services/lake-formation'
},
]
},
{
label: 'Build System',
items: [
{ label: 'Deployment Order', slug: 'components/build-system/deployment-order'},
{ label: 'CI Integration', slug: 'components/build-system/ci-integration'},
]
},
}
],
},
{
Expand All @@ -115,7 +116,8 @@ export default defineConfig({
{ label: 'API', slug: 'reference/api'},
{ label: 'Defaults', slug: 'reference/defaults'},
// { label: 'Config sharing', slug: 'introduction'},
{ label: 'Scripts & commands', slug: 'reference/scripts-commands'},
{ label: 'Scripts & commands', slug: 'reference/scripts-commands' },
{ label: 'Lake Formation TBAC strategy', slug: 'reference/lake-formation-tbac-recommended-strategy' },
// { label: 'Roadmap', slug: 'introduction'},
// { label: 'Escape Hatches', slug: 'introduction'}, // How to extend and modify/add components
]
Expand All @@ -126,9 +128,9 @@ export default defineConfig({
'./src/styles/custom.css',
],
plugins: [starlightImageZoom()],
})],
})],
markdown: {
rehypePlugins: [ [rehypeMermaid, {strategy: "img-png", mermaidConfig:{ theme: 'neutral' } }] ], // CSS styles do not apply, have to inline
rehypePlugins: [[rehypeMermaid, { strategy: "img-png", mermaidConfig: { theme: 'neutral' } }]], // CSS styles do not apply, have to inline
// rehypePlugins: [ rehypeMermaid ], //For occasional testing, see the SVG component and class names
},
});
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ for two accounts in the `Workloads` OU. Additional accounts can be added as need
</Fragment>
<Fragment slot="python">
```python
#!/usr/bin/env python3
import aws_cdk as cdk
import aws_data_landing_zone as dlz

Expand Down Expand Up @@ -131,8 +130,6 @@ for two accounts in the `Workloads` OU. Additional accounts can be added as need
)
),
)

app.synth()
````
</Fragment>
</DualCode>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ specified Slack channel and email address once the budget exceeds $100.
</Fragment>
<Fragment slot="python">
```python
#!/usr/bin/env python3
import aws_cdk as cdk
import aws_data_landing_zone as dlz

Expand All @@ -79,7 +78,6 @@ specified Slack channel and email address once the budget exceeds $100.
],
...
)
app.synth()
```
</Fragment>
</DualCode>
Expand Down Expand Up @@ -118,7 +116,6 @@ resources. Notifications are sent to the specified Slack channel and email addre
</Fragment>
<Fragment slot="python">
```python
#!/usr/bin/env python3
import aws_cdk as cdk
import aws_data_landing_zone as dlz

Expand All @@ -140,7 +137,7 @@ resources. Notifications are sent to the specified Slack channel and email addre
],
...
)
app.synth()

```
</Fragment>
</DualCode>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ Below is an example of defining a global region and one additional region.
</Fragment>
<Fragment slot="python">
```python
#!/usr/bin/env python3
import aws_cdk as cdk
import aws_data_landing_zone as dlz

Expand All @@ -49,7 +48,6 @@ Below is an example of defining a global region and one additional region.
),
...
)
app.synth()
```

</Fragment>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ Below is an example of defining a global region and one additional region.
</Fragment>
<Fragment slot="python">
```python
#!/usr/bin/env python3
import aws_cdk as cdk
import aws_data_landing_zone as dlz

Expand All @@ -48,7 +47,6 @@ Below is an example of defining a global region and one additional region.
),
...
)
app.synth()
```

</Fragment>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ SSO user.
</Fragment>
<Fragment slot="python">
```python
#!/usr/bin/env python3
import aws_cdk as cdk
import aws_data_landing_zone as dlz

Expand All @@ -97,8 +96,6 @@ SSO user.
)
),
)

app.synth()
````
</Fragment>
</DualCode>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,6 @@ for two accounts in the `Workloads` OU. Additional accounts can be added as need
</Fragment>
<Fragment slot="python">
```python
#!/usr/bin/env python3
import aws_cdk as cdk
import aws_data_landing_zone as dlz

Expand Down Expand Up @@ -193,8 +192,6 @@ for two accounts in the `Workloads` OU. Additional accounts can be added as need
)
),
)

app.synth()
````
</Fragment>
</DualCode>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ Note that while the code property is lowercase, the tags created will follow the
</Fragment>
<Fragment slot="python">
```python
#!/usr/bin/env python3
import aws_cdk as cdk
import aws_data_landing_zone as dlz

Expand All @@ -69,7 +68,7 @@ Note that while the code property is lowercase, the tags created will follow the
},
...
)
app.synth()

```
</Fragment>
</DualCode>
Expand Down Expand Up @@ -99,7 +98,6 @@ property.
</Fragment>
<Fragment slot="python">
```python
#!/usr/bin/env python3
import aws_cdk as cdk
import aws_data_landing_zone as dlz

Expand All @@ -113,7 +111,6 @@ property.
],
...
)
app.synth()
```
</Fragment>
</DualCode>
Expand Down
Loading
Loading