Giter VIP home page Giter VIP logo

Comments (3)

bpg avatar bpg commented on August 9, 2024 1

Thanks for offering help! ❤️

This change did the trick:

 ## Argument Reference
 
 - `clone` - (Optional) The cloning configuration.
-  - `datastore_id` - (Optional) The identifier for the target datastore.
-  - `node_name` - (Optional) The name of the source node (leave blank, if
-      equal to the `node_name` argument).
-  - `vm_id` - (Required) The identifier for the source container.
+    - `datastore_id` - (Optional) The identifier for the target datastore.
+    - `node_name` - (Optional) The name of the source node (leave blank, if
+        equal to the `node_name` argument).
+    - `vm_id` - (Required) The identifier for the source container.
 - `console` - (Optional) The console configuration.
-  - `enabled` - (Optional) Whether to enable the console device (defaults
-      to `true`).
-  - `mode` - (Optional) The console mode (defaults to `tty`).
-    - `console` - Console.
-    - `shell` - Shell.
-    - `tty` - TTY.
-  - `tty_count` - (Optional) The number of available TTY (defaults to `2`).
+    - `enabled` - (Optional) Whether to enable the console device (defaults
+        to `true`).
+    - `mode` - (Optional) The console mode (defaults to `tty`).
+        - `console` - Console.
+        - `shell` - Shell.
+        - `tty` - TTY.
+    - `tty_count` - (Optional) The number of available TTY (defaults to `2`).

from terraform-provider-proxmox.

bpg avatar bpg commented on August 9, 2024

Thanks @zmingxie, good catch!

I noticed wrong rendering in few other places as well.

The documentation pages are rendered from the markdown by Terraform Registry itself. And the syntax they are using is a bit different from a standard (or GitHub :) markdown.

Based on testing via https://registry.terraform.io/tools/doc-preview it looks like lists should be using double indentation.

from terraform-provider-proxmox.

zmingxie avatar zmingxie commented on August 9, 2024

Thanks @zmingxie, good catch!

I noticed wrong rendering in few other places as well.

The documentation pages are rendered from the markdown by Terraform Registry itself. And the syntax they are using is a bit different from a standard (or GitHub :) markdown.

Based on testing via https://registry.terraform.io/tools/doc-preview it looks like lists should be using double indentation.

Yes, I can reproduce the issue using the doc-preview too. However, I'm not sure what you mean by "double indentation" to fix it. Could you give me an example? I'm happy to review the doc and update all if you can show me the proper way. Thanks!

from terraform-provider-proxmox.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.