Skip to content

Commit 7d6b41a

Browse files
author
AWS Scripting Guy
committed
updated README to reflect YAML
1 parent bf257ec commit 7d6b41a

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,23 @@ Usage
2121
YAML templates
2222
------------------
2323

24-
Extension fully supports YAML templates. YAML template creation follows the same syntax rules: type **start** to populate new template.
24+
Extension fully supports YAML templates. YAML template creation follows the same syntax rules:
2525

26-
YAML Language Server is required.
27-
1. Install [YAML Language Server](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)
28-
2. Whitelist intrinsic function tags - paste preferences below into your User Settings (Ctrl + ,)
26+
1. Create new YAML document
27+
2. type **start** to populate new template
28+
3. **Start typing** desired **resource name** and hit ```tab``` key
29+
30+
> **Note:** YAML support is dependent on YAML Language Server.
31+
By default, YAML Language Server (Red Hat YAML recommended) will be installed automatically as prerequisite.
32+
33+
> **Note:** If you do not want to install YAML Language Server, install version **cform-noyaml.vsix** from GitHub [here]().
34+
35+
YAML setup
36+
------------------
37+
38+
After installation, open your User Settings ```(Ctrl + ,)``` and paste preferences below into your settings file.
39+
40+
> **Note:** This will whitelist CloudFormation intrinsic functions tags. Otherwise you will end up with *Unknown Tag* showing up in your YAML document.
2941
3042
```json
3143
// Custom tags for the parser to use
@@ -64,21 +76,24 @@ Known issues
6476
When working with YAML documents, your current YAML language interpreter might not support syntax of AWS intrinsic functions, thus marking them as *unknown tag*.
6577
This however has no effect on validity of the YAML document.
6678

67-
> **Note:** You can solve this issue by whitelisting specific tags following instructions under section **YAML Templates**.
79+
> **Note:** You can solve this issue by whitelisting specific tags following instructions under section **YAML Setup**.
6880
6981
> **Note:** Tested only with Red Hat YAML Language Server
7082
7183
![YAML known issue](https://raw.githubusercontent.com/aws-scripting-guy/cform-VSCode/master/assets/known_issue1.png)
7284

73-
Contributing
85+
Contributions
7486
-------------------
87+
Contributions:
7588

7689
1. Fork
7790
2. Create your feature branch (git checkout -b my-new-feature)
7891
3. Commit your changes (git commit -am 'Add some feature')
7992
4. Push to the branch (git push origin my-new-feature)
8093
5. Create new Pull Request
8194

95+
Feedback is welcome.
96+
8297
Donations appreciated :)
8398
-------------------
8499

0 commit comments

Comments
 (0)