Skip to content
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

Alert notification API #1202

Merged

Conversation

nicholaspcr
Copy link
Contributor

@nicholaspcr nicholaspcr commented Oct 23, 2023

Summary

References https://github.com/TheThingsIndustries/lorawan-stack/pull/3911
References https://github.com/TheThingsIndustries/product-management/issues/4

Introduces the documentation of Alert Notification API present on IS.

Screenshots

screenshots
Gateway.md update

image

IS API

localhost_1313_reference_api_identity_server_

image

profile CLI

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-profiles_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-profiles_create_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-profiles_delete_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-profiles_get_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-profiles_get-default_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-profiles_list_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-profiles_update_

Receivers CLI

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-receivers_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-receivers_create_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-receivers_delete_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-receivers_get_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-receivers_list_

localhost_1313_ttn-lw-cli_ttn-lw-cli_alert-notification-receivers_update_

Changes

  • Add the new generated doc files from ttes.
  • Update API definition for IS
  • Add AlertNotificationProfileIdentifiers message to gateway's API section.
  • Update ttn-lw-cli.json to include new experimental CLI commands on the command line interface documentation section.

Notes for Reviewers

Checklist

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Run Locally: Verified that the docs build using make server, posted screenshots, verified external links. Test with HUGO_PARAMS_SEARCH_ENABLED=true if style changes will affect the search bar.
  • New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
  • Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
  • Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

@nicholaspcr nicholaspcr self-assigned this Oct 23, 2023
@KrishnaIyer
Copy link
Contributor

I think this PR should either go also to a feature branch or be held until the feature is complete and this PR covers the full functionality.

@nicholaspcr
Copy link
Contributor Author

I agree, left it as a draft with the intention of only merging it when the PR referenced goes into a release.

Will do the same process as what is done on enterprise, change the target to a feature branch.

@nicholaspcr nicholaspcr changed the base branch from master to feature/alert-notification-docs October 25, 2023 12:06
@nicholaspcr nicholaspcr force-pushed the doc/alert-notification-api branch from 42a473b to dee842c Compare October 25, 2023 12:06
@nicholaspcr
Copy link
Contributor Author

With the previous topic more defined, I'll make this PR ready for review after the api section of the PR is approved.
Avoiding duplicate work every time an API change is requested

nejraselimovic and others added 3 commits October 25, 2023 17:18
* doc: Update TTS Plans info

* fixup! doc: Update TTS Plans info

* fixup! doc: Update TTS Plans info

* doc: Add downgrading plan info
Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.54.0 to 1.56.3.
- [Release notes](https://github.com/grpc/grpc-go/releases)
- [Commits](grpc/grpc-go@v1.54.0...v1.56.3)

---
updated-dependencies:
- dependency-name: google.golang.org/grpc
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@nicholaspcr nicholaspcr force-pushed the doc/alert-notification-api branch 2 times, most recently from e2ed11c to bcd8e27 Compare November 2, 2023 22:24
@nicholaspcr
Copy link
Contributor Author

@nejraselimovic could you give me a hand with an error I'm having on these changes?

After changing doc/data/commands/ttn-lw-cli.json I'm getting a bunch of REF_NOT_FOUND errors in CLI command files, which are not related to the new commands, and I can't identify what am I'm doing wrong.

Full error example:

ERROR 2023/11/02 19:27:14 [en] REF_NOT_FOUND: Ref "ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_get" from page "ttn-lw-cli/ttn-lw-cli_users_set.md": page not found

* doc: Add v3.28.0 release docs

* doc: Add new services to IS API docs
@nejraselimovic
Copy link
Contributor

@nejraselimovic could you give me a hand with an error I'm having on these changes?

After changing doc/data/commands/ttn-lw-cli.json I'm getting a bunch of REF_NOT_FOUND errors in CLI command files, which are not related to the new commands, and I can't identify what am I'm doing wrong.

Full error example:

ERROR 2023/11/02 19:27:14 [en] REF_NOT_FOUND: Ref "ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_get" from page "ttn-lw-cli/ttn-lw-cli_users_set.md": page not found

/doc/data/commands is being auto-generated with every new release, so I think you shouldn't be adding that manually? See release docs template

@nicholaspcr nicholaspcr force-pushed the doc/alert-notification-api branch from bcd8e27 to 9ea335f Compare November 6, 2023 21:11
@nicholaspcr
Copy link
Contributor Author

/doc/data/commands is being auto-generated with every new release, so I think you shouldn't be adding that manually? See release docs template

@nejraselimovic thanks, missed this somehow and was a bit lost.
Silly mistake on my end and I appreciate you taking your time to help me.

@nicholaspcr nicholaspcr marked this pull request as ready for review November 6, 2023 21:25
@nicholaspcr nicholaspcr force-pushed the doc/alert-notification-api branch from 9ea335f to b524299 Compare November 6, 2023 21:30
Copy link
Contributor

@nejraselimovic nejraselimovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me it looks good, docs are building correctly, but I suggest you wait for another reviewers' approval just in case I'm missing something

Bumps [golang.org/x/image](https://github.com/golang/image) from 0.7.0 to 0.10.0.
- [Commits](golang/image@v0.7.0...v0.10.0)

---
updated-dependencies:
- dependency-name: golang.org/x/image
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Copy link
Contributor

@adriansmares adriansmares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

I think some of the changes here are part of #1206 , which wasn't available when this branch was created. I suggest rebasing on top of master both the feature branch and this branch.

nejraselimovic and others added 5 commits November 12, 2023 18:13
* doc: Use cards in sub sections

* doc: Move best practices

* doc: Expand concepts

* doc: Move models to a sub section

* doc: Add configuration content

* doc: Restructure adding devices

* doc: Recreate adding devices

* doc: Add other sections

* doc: Update aliases

* doc: Update introductory passage

* doc: Update guide
@nicholaspcr nicholaspcr force-pushed the doc/alert-notification-api branch from b524299 to cf93dc0 Compare November 14, 2023 15:49
@nicholaspcr nicholaspcr merged commit f0beece into feature/alert-notification-docs Nov 14, 2023
1 check passed
@nicholaspcr nicholaspcr deleted the doc/alert-notification-api branch November 14, 2023 15:52
nicholaspcr added a commit that referenced this pull request Jan 17, 2024
* doc: Update TTS Plans info (#1190)

* doc: Update TTS Plans info

* fixup! doc: Update TTS Plans info

* fixup! doc: Update TTS Plans info

* doc: Add downgrading plan info

* doc: Update redirects (#1204)

* build(deps): bump google.golang.org/grpc from 1.54.0 to 1.56.3 (#1203)

Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.54.0 to 1.56.3.
- [Release notes](https://github.com/grpc/grpc-go/releases)
- [Commits](grpc/grpc-go@v1.54.0...v1.56.3)

---
updated-dependencies:
- dependency-name: google.golang.org/grpc
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* doc: Add v3.28.0 release docs (#1206)

* doc: Add v3.28.0 release docs

* doc: Add new services to IS API docs

* build(deps): bump golang.org/x/image from 0.7.0 to 0.10.0 (#1207)

Bumps [golang.org/x/image](https://github.com/golang/image) from 0.7.0 to 0.10.0.
- [Commits](golang/image@v0.7.0...v0.10.0)

---
updated-dependencies:
- dependency-name: golang.org/x/image
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* doc: Subscription and billing mgmt FAQ update (#1211)

* Restructure and update `devices` section (#1210)

* doc: Use cards in sub sections

* doc: Move best practices

* doc: Expand concepts

* doc: Move models to a sub section

* doc: Add configuration content

* doc: Restructure adding devices

* doc: Recreate adding devices

* doc: Add other sections

* doc: Update aliases

* doc: Update introductory passage

* doc: Update guide

* doc: Add receiver methods to identity_server api

* doc: Add profile methods to identity_server api

* doc: Add alertNotificationProfileIdentifiers to gateway api

* doc: Add TTES's hugo generated docs

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Nejra Selimović <[email protected]>
Co-authored-by: Krishna Iyer <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants