W-14408363 improve exchange upload info bsj #83
Conversation
| |Flag and Options|Result|Example | ||
| |The ruleset YAML using the `--files` flag with the `"ruleset.yaml"` option. | ||
| |This uploads the ruleset information included in the YAML file and ignores any other files detected in the same folder, such as the `exchange.json` file. You can use `--type=ruleset`. If you don't, the type is inferred from the `--files` flag `--ruleset.yaml` option. | ||
| |`--files='{"ruleset.yaml":"mynewruleset.yaml", "docs.zip": "ruleset.doc.zip"}'` |
There was a problem hiding this comment.
I agree as you've said that docs.zip is a feature provided by exchange for all assets. I was just trying to give examples of the things they can do vs. them needing to use the CLI reference to figure out what they need. I'll work with Jenny and Nanda to try and organize the examples and exchange.json reference content in appropriate/logical places in the doc.
I've made this PR a draft as a place to write and gather information for now. Stay tuned for more later on.
Thanks for your feedback!
| [%header,cols="35a,65a"] | ||
| |=== | ||
| |Property|Description | ||
| |main|The main file of your asset. Ensure that this matches the name of your ruleset when publishing a ruleset. |
There was a problem hiding this comment.
what does "the name of your ruleset" mean? I could publish anypoint-best-practices and have the ruleset file called ruleset.yaml, and it would work fine.. should it state your ruleset file relative path?
| |assetId|The Exchange asset ID assigned to the asset. | ||
| |version|The asset version. | ||
| |classifier|The asset type. Use the value `"ruleset"` when publishing a ruleset asset. | ||
| |dependencies| Rulesets can have fragments defined as dependencies. |
There was a problem hiding this comment.
I would either not mention this or explain it more with an example...
| |version|The asset version. | ||
| |classifier|The asset type. Use the value `"ruleset"` when publishing a ruleset asset. | ||
| |dependencies| Rulesets can have fragments defined as dependencies. | ||
| |tags| Tags for a ruleset asset's details in Exchange. |
There was a problem hiding this comment.
this tags are not automatically applied to the asset :(
|
This is a working draft to figure out what information we need to document and get feedback. I'll move this to the doc-exchange and/or doc-anypoint-cli repo when we get closer to ready to publish. |
No description provided.