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

Release 3.33.0 documentation #1395

Merged
merged 4 commits into from
Jan 16, 2025
Merged

Release 3.33.0 documentation #1395

merged 4 commits into from
Jan 16, 2025

Conversation

TheThingsBot
Copy link
Contributor

@TheThingsBot TheThingsBot commented Jan 13, 2025

Summary

Release 3.33.0 documentation.

Automatic Changes

  • Added documentation for 3.33.0.

Manual Changes

  • Update the 'featured' section in 'doc/content/whats-new/3.33.0.md' with only selected items that should be featured.
  • If the are build errors due to missing message definitions, manually add the new and definitions where necessary.

Checklist for Reviewers

doc/data/api/tti.lorawan.v3/messages.yml
doc/data/api/tti.lorawan.v3/services.yml
doc/data/api/tti.lorawan.v3/enums.yml
doc/data/api/ttn.lorawan.v3/messages.yml
doc/data/api/ttn.lorawan.v3/services.yml
doc/data/api/ttn.lorawan.v3/enums.yml
  • The TTI CLI documentation has been generated and updated in doc/data. This includes the following files:
doc/data/commands/ttn-lw-cli.json
doc/content/ttn-lw-cli/*.md
  • All generated documentation matches the version that is being released.

@happyRip
Copy link
Member

happyRip commented Jan 13, 2025

We're missing the definitions for some messages. The Tutorials seem more complex.

ERROR Referenced type not rendered:  "EmailNotificationPreferences" in page ".../lorawan-stack-docs/doc/content/api/reference/grpc/user.md:205:1"
ERROR Referenced type not rendered:  "UserConsolePreferences.Tutorials" in page ".../lorawan-stack-docs/doc/content/api/reference/grpc/user.md:205:1"

edit: Solved

@@ -8,6 +8,8 @@ All meaningful changes to templates are documented in this file.

## Unreleased

## 3.32.3
Copy link
Contributor

Choose a reason for hiding this comment

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

This is incorrect right?

Copy link
Member

Choose a reason for hiding this comment

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

Seems correct, but I don't know why it wasn't added with v3.32.3 https://github.com/TheThingsIndustries/lorawan-stack-aws/blob/v3.33/UPGRADING.md#3323

Unless it's incorrect in lw-stack-aws as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

We are releasing documentation for v3.33.0 and the latest change here says it's for v3.32.3 and that doesn't seem incorrect?

Copy link
Member

Choose a reason for hiding this comment

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

Looking through the process the reason for this incorrectness in this release and the previous release is the fact that this PR Release v3.33.0 is not merged, which is the trigger to AWS templates release action.

Turns out that's the reason why tag release and docs release wasn't done in parallel -> docs release needs this PR to be merged already and AWS release finished.

Copy link
Member

Choose a reason for hiding this comment

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

Fixed in 1199c62 to match UPGRADING.md

@happyRip happyRip requested a review from KrishnaIyer January 15, 2025 12:53
@happyRip happyRip merged commit 6fea088 into master Jan 16, 2025
1 check passed
@happyRip happyRip deleted the release/3.33.0 branch January 16, 2025 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants