-
Notifications
You must be signed in to change notification settings - Fork 106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
@cap-js/notifications plugin documentation #487
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Linting Errors
- guides/notifications/index.md:28:1 container type should be specified [Context: "::: Details Behind the Scenes…"]
guides/notifications/index.md
Outdated
npm add @cap-js/notifications | ||
``` | ||
|
||
::: Details Behind the Scenes… |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
::: Details Behind the Scenes… | |
::: details Details Behind the Scenes… |
You have to specify a container type. Possible values: info, tip, warning, danger, details, code-group, raw.
…into notifications_plugin
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling Mistakes
- ./guides/notifications/index.md:79:68 Unknown word "deployement"
Generally, for each spelling mistake there are 2 ways to fix it:
- Fix the spelling mistake and commit it.
- The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.
guides/notifications/index.md
Outdated
cds env requires.notifications --profile production | ||
``` | ||
|
||
4. If the project contains `mta.yaml` file, then following content deployement job configuration is added which creates/updates the notification types during deployment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
4. If the project contains `mta.yaml` file, then following content deployement job configuration is added which creates/updates the notification types during deployment. | |
4. If the project contains `mta.yaml` file, then following content deployment job configuration is added which creates/updates the notification types during deployment. |
Or maybe one of these: deployments, devolvement, denouement, deportment?
Hi @AnmolBinani , I learned yesterday how we're going to document plugins:
Please adapt this PR accordingly. Thanks a lot :) |
Hi @renejeglinsky , In that case we don't need this PR at all right? We will simply add information in the CAPire and link the CAP Plug-in |
Yes, either close this one here or reuse it for the information in the plugins section. :) |
Now there's already some documentation filled in the plugins section by Daniel H.: dd74aa2 |
CAPire documentation for the cap-js/notifications plugin