Skip to content

Commit 436af9c

Browse files
Felonious-Spellfirenicolai86
authored andcommitted
Fixes note formatting and more (#14264)
Fixes formatting for a note and makes headings for arguments and parameters stand out
1 parent 190e200 commit 436af9c

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/source-app/workflows/byoc/index.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,21 @@ Here's an example:
4646
4747
lightning create cluster my-byoc-cluster --provider aws --role-arn arn:aws:iam::1234567890:role/lai-byoc --external-id dummy --region us-west-2 --instance-types t3.xlarge --enable-performance
4848
49-
..note:: Cluster creation is going to take an hour or more after you run this command.
49+
.. note:: Cluster creation is going to take an hour or more after you run this command.
5050

51-
**Arguments**
51+
----
52+
53+
Arguments
54+
^^^^^^^^^
5255

5356
* cluster_name: The name of the cluster to be created
5457

5558
.. note:: Cluster names can only contain lowercase letters, numbers, and periodic hyphens ( - ).
5659

57-
**Parameters:**
60+
----
61+
62+
Parameters
63+
^^^^^^^^^^
5864

5965
+------------------------+----------------------------------------------------------------------------------------------------+
6066
|Parameter | Descritption |
@@ -104,7 +110,7 @@ Delete a Lightning BYOC cluster
104110

105111
Deletes a Lightning BYOC cluster. Lightning AI removes cluster artifacts and any resources running on the cluster.
106112

107-
.. warning:: Using the --force parameter when deleting a cluster does not clean up any resources managed by Lightning AI. Check your cloud provider to verify that existing cloud resources are deleted.
113+
.. warning:: Using the ``--force`` parameter when deleting a cluster does not clean up any resources managed by Lightning AI. Check your cloud provider to verify that existing cloud resources are deleted.
108114

109115
Deletion permanently removes not only the record of all runs on a cluster, but all associated artifacts, metrics, logs, etc.
110116

0 commit comments

Comments
 (0)