docs: announce version 17 #2065

profanis · 2023-09-26T11:08:04Z

WIP

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/ngxs/store/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[ ] No

Other information

nx-cloud · 2023-09-26T11:09:09Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit de99dad. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 3 targets

Sent with 💌 from NxCloud.

bundlemon · 2023-09-26T11:13:53Z

BundleMon (Integration Projects)

Unchanged files (2)

Status	Path	Size	Limits
✅	Main bundles(Gzip) _{hello-world-ng17/dist-integration/main.(hash) .js}	68.5KB	+1%
✅	Main bundles(Gzip) _{hello-world-ng16/dist-integration/main.(hash) .js}	67.03KB	+1%

No change in files bundle size

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

nx-cloud · 2024-03-11T20:21:03Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 370ea7f. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 4 targets

Sent with 💌 from NxCloud.

joaqcid

LGTM

markwhitfeld

Feedback from a quick review

publication/2024-04-05_announcing_ngxs_17/article.md

arturovt · 2024-04-12T13:48:56Z

publication/2024-04-05_announcing_ngxs_17/article.md

+
+NGXS provides a robust error handling mechanism that automatically catches unhandled exceptions thrown within actions. These errors are then directed to a centralized `ErrorHandler`.
+
+However, you can override the default implementation and provide your custom one


Suggested change

However, you can override the default implementation and provide your custom one

However, you can override the default implementation and provide your custom one.

arturovt · 2024-04-12T13:50:11Z

publication/2024-04-05_announcing_ngxs_17/article.md

+
+---
+
+## Plugin Improvements


I believe that plugin improvements should be placed at the end. This is because it describes that some of the symbols are now privately exported, which is less prioritized compared to other information we're providing in these docs.

good point! I moved it just before the NGXS Community section. My thought was to have the NGXS community section as the closure.
Do you think the Plugin Improvements should be the last section of the readme?

Maybe we should have the discord link at the very top, like 'first of all, we're moving to discord' or something?

Two things about the Discord question

Is this "move" to Discord in relation to Slack being the default currently (from what I can tell at the moment)? I joined the Slack recently as it seemed to be pinned to the top of the README.md. If so, in my opinion I definitely would highlight the move to Discord towards the top of this announcement post, or at the least not at the very bottom.

If I am correct in this assumption, make sure to update the README.md badge as well as I assume the NGXS Labs contact part.

Thanks for your comment @michael-small
Indeed makes sense to move that on top. As of your second point, the README.md file has been updated and currently is part of the development version

michael-small

Two questions about this version, reading this as if I had no context with what is going on now. Technically I don't know as much anyways, but I know I have had the pleasure of meeting up with some team members recently so I am reading this article with some more context than most other users who will read this post.

The article declares that this is NGXS 17, but the branch name is announcing 3.9. Are versions from NGXS 17+ going to be 1:1 with Angular majors? If so, in my opinion I would highlight this in the article.
I don't know what the compatibility matrix of Angular versions to NGXS would be with NGXS 17, but if it is different than previous version upgrades I would also call this out in the announcement. At least the minimum version to use the standalone and signal changes.

markwhitfeld

Thank you for the changes!
@michael-small makes very good points. Could you add a paragraph at the beginning about aligning versions with Angular, in order to readily take advantage of the latest features as the framework continues to evolve.
And a mention of the minimum version required for the signals and standalone support.

codeclimate · 2024-04-15T10:33:22Z

Code Climate has analyzed commit 370ea7f and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 95.3% (0.0% change).

View more on Code Climate.

profanis force-pushed the docs/announce_3.9 branch 3 times, most recently from 0c86e73 to de99dad Compare October 30, 2023 15:02

profanis and others added 6 commits April 5, 2024 16:28

docs: announce 3.9

8a96d60

docs: document the router plugin changes

e01d892

docs: document the storage plugin changes

6da4e4a

docs: add selectSignal

e12426e

docs: document the storage plugin changes

eccbd68

docs: announce version 17

0cebaa9

profanis force-pushed the docs/announce_3.9 branch from d0ff7dd to 0cebaa9 Compare April 10, 2024 07:51

docs: promote discord

13daed4

profanis changed the title ~~docs: announce 3.9~~ docs: announce version 17 Apr 10, 2024

profanis marked this pull request as ready for review April 10, 2024 08:00

profanis requested review from markwhitfeld, arturovt, kuncevic, Carniatto, poloagustin, joaqcid and splincode as code owners April 10, 2024 08:00

joaqcid approved these changes Apr 10, 2024

View reviewed changes

profanis added 2 commits April 10, 2024 18:00

fix(docs): replace braking with breaking

3984e84

fix(docs): remove the section - getState() returns DeepReadOnly

06a147b

markwhitfeld requested changes Apr 10, 2024

View reviewed changes

markwhitfeld and others added 2 commits April 12, 2024 11:41

Merge branch 'master' into docs/announce_3.9

07eb5f9

docs: add dispatch utilities and apply fixes

6b63841

profanis requested a review from markwhitfeld April 12, 2024 12:58

arturovt reviewed Apr 12, 2024

View reviewed changes

chore: move plugin improvements before ngxs community

c49a4de

profanis requested a review from arturovt April 13, 2024 12:14

michael-small reviewed Apr 13, 2024

View reviewed changes

markwhitfeld requested changes Apr 14, 2024

View reviewed changes

docs: move discord to top

370ea7f

profanis requested a review from markwhitfeld April 15, 2024 10:30

markwhitfeld approved these changes Apr 15, 2024

View reviewed changes

markwhitfeld merged commit fc98e14 into ngxs:master Apr 15, 2024
12 checks passed

markwhitfeld added this to the v.18.0.0 milestone Jun 24, 2024

markwhitfeld added the released label Jun 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: announce version 17 #2065

docs: announce version 17 #2065

profanis commented Sep 26, 2023

nx-cloud bot commented Sep 26, 2023 •

edited

Loading

bundlemon bot commented Sep 26, 2023 •

edited

Loading

nx-cloud bot commented Mar 11, 2024 •

edited

Loading

joaqcid left a comment

markwhitfeld left a comment

arturovt Apr 12, 2024

arturovt Apr 12, 2024

profanis Apr 13, 2024

arturovt Apr 13, 2024

michael-small Apr 13, 2024

profanis Apr 15, 2024

michael-small left a comment •

edited

Loading

markwhitfeld left a comment

codeclimate bot commented Apr 15, 2024


		NGXS provides a robust error handling mechanism that automatically catches unhandled exceptions thrown within actions. These errors are then directed to a centralized `ErrorHandler`.

		However, you can override the default implementation and provide your custom one

docs: announce version 17 #2065

docs: announce version 17 #2065

Conversation

profanis commented Sep 26, 2023

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

nx-cloud bot commented Sep 26, 2023 • edited Loading

☁️ Nx Cloud Report

bundlemon bot commented Sep 26, 2023 • edited Loading

BundleMon (Integration Projects)

nx-cloud bot commented Mar 11, 2024 • edited Loading

☁️ Nx Cloud Report

joaqcid left a comment

Choose a reason for hiding this comment

markwhitfeld left a comment

Choose a reason for hiding this comment

arturovt Apr 12, 2024

Choose a reason for hiding this comment

arturovt Apr 12, 2024

Choose a reason for hiding this comment

profanis Apr 13, 2024

Choose a reason for hiding this comment

arturovt Apr 13, 2024

Choose a reason for hiding this comment

michael-small Apr 13, 2024

Choose a reason for hiding this comment

profanis Apr 15, 2024

Choose a reason for hiding this comment

michael-small left a comment • edited Loading

Choose a reason for hiding this comment

markwhitfeld left a comment

Choose a reason for hiding this comment

codeclimate bot commented Apr 15, 2024

nx-cloud bot commented Sep 26, 2023 •

edited

Loading

bundlemon bot commented Sep 26, 2023 •

edited

Loading

nx-cloud bot commented Mar 11, 2024 •

edited

Loading

michael-small left a comment •

edited

Loading