Skip to content

chore: Move AWS docs to MD from MDX#14505

Merged
kodiakhq[bot] merged 2 commits intocloudquery:mainfrom
erezrokah:chore/move_aws_to_md
Oct 12, 2023
Merged

chore: Move AWS docs to MD from MDX#14505
kodiakhq[bot] merged 2 commits intocloudquery:mainfrom
erezrokah:chore/move_aws_to_md

Conversation

@erezrokah
Copy link
Copy Markdown
Member

Summary

Same as #14484 for AWS. Part of https://github.com/cloudquery/cloudquery-issues/issues/620 (internal issue).

"react-hot-toast": "2.4.0",
"react-search-box": "^3.0.0",
"remark-directive": "^3.0.0",
"remark-directive": "^2.0.0",
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had to downgrade this package so it's compatible with Nextra built-in packages for rendering markdown

@@ -117,9 +115,9 @@ This is the (nested) spec used by the AWS source plugin.
Currently only `aws_costexplorer*` and `aws_alpha_cloudwatch_metric*` tables require this flag to be set to `true`.


<Callout type="warn">
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warn was a bug, the correct type is warning

const pluginTitle = (plugin) => title(plugin.replace(/-/g, " "));

const getData = (pluginsDir, plugin) => {
const readPluginOverview = (pluginsDir, plugin) => {
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed this in #14484. We read the overview.mdx file to get the title and stage for https://www.cloudquery.io/docs/plugins/sources/overview and https://www.cloudquery.io/docs/plugins/destinations/overview

@erezrokah erezrokah added the automerge Automatically merge once required checks pass label Oct 12, 2023
@kodiakhq kodiakhq bot merged commit 894fdaa into cloudquery:main Oct 12, 2023
@erezrokah erezrokah deleted the chore/move_aws_to_md branch October 12, 2023 18:16
kodiakhq bot pushed a commit that referenced this pull request Oct 13, 2023

#### Summary

Follow up to #14505. We should use a plain MD comment instead of an MDX one

<!--
hydratim pushed a commit to hydratim/cloudquery that referenced this pull request Oct 20, 2023
hydratim pushed a commit to hydratim/cloudquery that referenced this pull request Oct 20, 2023

#### Summary

Follow up to cloudquery#14505. We should use a plain MD comment instead of an MDX one

<!--
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/website automerge Automatically merge once required checks pass

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants