Skip to content

Commit 7584850

Browse files
committed
clarify doc about Comments and formatting
1 parent bee0dfb commit 7584850

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

docs/command_adv2v2.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ atlas tf adv2v2 -f in.tf -o out.tf
2626
- `--replaceOutput` or `-r`: Overwrite the file at the output path if it already exists. You can also modify the input file in-place.
2727
- `--watch` or `-w`: Keep the plugin running and watching for changes in the input file
2828

29+
## Comments and formatting
30+
31+
During the conversion process, some formatting elements may not be preserved:
32+
- Some comments from the original resources may not be preserved in the output
33+
- Custom blank lines and spacing may be modified
34+
- The output file will have standardized formatting
35+
36+
We recommend reviewing the converted output and re-adding any important comments or documentation that you need to maintain.
37+
2938
## Examples
3039

3140
You can find [here](https://github.com/mongodb-labs/atlas-cli-plugin-terraform/tree/main/internal/convert/testdata/adv2v2) examples of input files (suffix .in.tf) and the corresponding output files (suffix .out.tf).

docs/command_clu2adv.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ atlas tf clu2adv -f in.tf -o out.tf
2626
- `--watch` or `-w`: Keep the plugin running and watching for changes in the input file
2727
- `--includeMoved` or `-m`: Include the `moved blocks` in the output file
2828

29+
## Comments and formatting
30+
31+
During the conversion process, some formatting elements may not be preserved:
32+
- Some comments from the original resources may not be preserved in the output
33+
- Custom blank lines and spacing may be modified
34+
- The output file will have standardized formatting
35+
36+
We recommend reviewing the converted output and re-adding any important comments or documentation that you need to maintain.
37+
2938
## Examples
3039

3140
You can find [here](https://github.com/mongodb-labs/atlas-cli-plugin-terraform/tree/main/internal/convert/testdata/clu2adv) some examples of input files (suffix .in.tf) and the corresponding output files (suffix .out.tf).

0 commit comments

Comments
 (0)