Create setting-policies-for-an-app.md #630
Conversation
|
Hi! I'm VTEX IO CI/CD Bot and I'll be helping you to publish your app! 🤖 Please select which version do you want to release:
And then you just need to merge your PR when you are ready! There is no need to create a release commit/tag.
|
| - a `name`, which is a unique identifier of a given policy. | ||
| - a `reason`, which may briefly describe the policy. | ||
|
|
||
| >:warning: **Keep in mind:** The `reason` may aid the person who wants to install the app in taking the decision of installing it or not. |
There was a problem hiding this comment.
Remember to use the div disclaimer
|
|
||
| ### Referencing a set of policies | ||
|
|
||
| We also allow an app to export a `policies.json` file, containing a given set of policies. To reference one of those in your app manifest, you may set the `name` value as the app name that declared the `policies.json` followed by the policy name, as in `{account}.{app-name}@{version}:{policy-name}`. |
There was a problem hiding this comment.
| We also allow an app to export a `policies.json` file, containing a given set of policies. To reference one of those in your app manifest, you may set the `name` value as the app name that declared the `policies.json` followed by the policy name, as in `{account}.{app-name}@{version}:{policy-name}`. | |
| We also allow an app to export a `policies.json` file, containing a given set of policies. | |
| To reference one of those in your app manifest, you may set the `name` value as the app name that declared the `policies.json` followed by the policy name, as in `{account}.{app-name}@{version}:{policy-name}`. |
There was a problem hiding this comment.
Acho que vale esclarecer mais quando usar um e quando usar outro. Tipo, quando eu crio um arquivo e quando não? Quando é vantajoso, sabe? Isso pode ficar mais explícito. O que acha?
Além disso, acho que podemos mastigar mais como esse file deve ser estruturado, digo, como deve ser a estrutura desse artigo? Parece que engolimos um passo, que é o de montar o artigo, e fomos para como referenciá-lo.
|
|
||
| Notice that `catalog-proxy` is the `name` of a policy previously declared in a `policies.json` file of the `app-name` app. | ||
|
|
||
| ## Modus Operandis |
There was a problem hiding this comment.
A gente pode ou não usar essas seções em recipes/tutoriais. Faz mais sentido usar em documentações de app, quando queremos explicar como a app tal funciona. No caso da recipe, ela em si já explica o Modus Operandi, então podemos omitir.
Co-authored-by: Bia <52087100+guerreirobeatriz@users.noreply.github.com>
Co-authored-by: Bia <52087100+guerreirobeatriz@users.noreply.github.com>
Co-authored-by: Bia <52087100+guerreirobeatriz@users.noreply.github.com>
What problem is this solving?
How should this be manually tested?
Screenshots or example usage: