doc: Adds import block syntax and use L2 heading to show in sidebar #2930
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tion and use `import` block syntax
EspenAlbert
commented
Dec 26, 2024
| @@ -34,7 +34,7 @@ export MONGODB_ATLAS_ENABLE_PREVIEW="true" | |||
|
|
|||
| trap 'rm -R docs-out/' EXIT # temp dir cleanup when script exits | |||
|
|
|||
| tfplugindocs generate --tf-version "${TF_VERSION}" --website-source-dir "${TEMPLATE_FOLDER_PATH}" --rendered-website-dir "docs-out" | |||
| tfplugindocs generate --tf-version "${TF_VERSION}" --website-source-dir "${TEMPLATE_FOLDER_PATH}" --rendered-website-dir "docs-out" --provider-name "mongodbatlas" | |||
There was a problem hiding this comment.
Supports running from a directory that doesn't use the conventional folder name of terraform-provider-mongodbatlas
EspenAlbert
changed the title
EspenAlbert
changed the title
|
APIx bot: a message has been sent to Docs Slack channel |
andreaangiolillo
approved these changes
Dec 27, 2024
maastha
reviewed
Dec 27, 2024
|
This PR has gone 7 days without any activity and meets the project’s definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy! |
lantoli
reviewed
Jan 7, 2025
| @@ -212,7 +212,7 @@ Read-Only: | |||
|
|
|||
| - `valid` (Boolean) Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data. | |||
|
|
|||
| # Import | |||
| ## Import | |||
There was a problem hiding this comment.
@EspenAlbert good catch!
I don't know if it's easy to see if it's happening in other docs, e.g. search string " #" only appears in first line of the docs
lantoli
approved these changes
Jan 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds import block syntax and fixes indent level of heading (see image below)
Link to any related issue(s): CLOUDP-273976 #2550
Type of change:
Required Checklist:
Further comments