Release 1.32 rewrite news doc

Jcahilltorre commented 2 months ago

Timo

[x] Add the Full Changelog to the release announcement as a closing statement. s

PR to address this feedback from @callahad :

At a very high level:

[x] We need to write for an audience that doesn't know anything about Unit and and doesn't care about its history. For example, we should:
- [x] Open with a single sentence stating what Unit is.
- [x] Lead with WASI 0.2 / Preview 2 support before we say anything about the deprecated bespoke Wasm support. Nobody cares about 1.31, they care about what 1.32 means for WebAssembly in Unit.
- [x] Revise the feature bullets to make sense for someone who isn't on the team. E.g., "conditional access logging" and "added a new variable request_id" don't tell me anything about what this is or why I should care.
- [x] The same applies later on (e.g., "Node JS Language Module enhancements" tells me nothing. And we had similarly notable fixes for Python and Ruby.)
[x] Sequence the sections by order of importance. Wasm first. GitHub toward the end.
[x] The Changes in Behavior section should talk more about the Docker change; it’s pretty significant. All logs are going to stderr instead of stdout now. If we think it’s useful to separately route access logs to stdout, we should either make that the default, or we should provide an example for how it can be done.

tippexs commented 2 months ago

Other things:

[x] Verify with Alex Crichton if/how he'd like to be credited (e.g., should we mention "of Fermyon"?)
[x] Mention sources.nginx.org/unit/ for tarballs, old URLs still work.
[x] The GitHub section should probably link to things in a few places (e.g., the Docs repo)
[x] Should the NJS section bold keywords like "pass", "rewrite", and "Cache-Control"
[x] Be more vague about the forthcoming blogpost; don't lock us in to a title yet :)
[x] "Node.js" not "Node JS"
[ ] Do we want to summarize other folks' contributions?

tippexs commented 2 months ago

@callahad please order your feedback in three buckets.

Blocker! Do not ship unitl resolved
Important! Please update within a week after the release
Info! No action required, consider for next release.

This will help us working on the most important items first.

re.

Revise the feature bullets to make sense for someone who isn't on the team. E.g., "conditional access logging" and "added a new variable request_id" don't tell me anything about what this is or why I should care. The same applies later on (e.g., "Node JS Language Module enhancements" tells me nothing. And we had similarly notable fixes for Python and Ruby.)

We will add the CHANGES to the bottom of the annouce message which will have a little more context about the Python and Node.js changes. I think for this release we are good about referencing to the CHANGES section.

For other features like conditional access logging there is a complete and very detailed section in the announce message. Ususally we didn't write a lot of text about a new variable we have added. I would suggest the link to the CHANGES in good for this release but should be changed for the next one.

netlify[bot] commented 2 months ago

Deploy Preview for nginx-unit ready!

Name	Link
Latest commit	efd4f010f71f50952b3dee1d2dd9458c4874e1e3
Latest deploy log	https://app.netlify.com/sites/nginx-unit/deploys/65ddb7528561b9000826acc0
Deploy Preview	https://deploy-preview-110--nginx-unit.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Jcahilltorre commented 2 months ago

@callahad please order your feedback in three buckets.

Blocker! Do not ship unitl resolved

Important! Please update within a week after the release

Info! No action required, consider for next release.

This will help us working on the most important items first.

re.

Revise the feature bullets to make sense for someone who isn't on the team. E.g., "conditional access logging" and "added a new variable request_id" don't tell me anything about what this is or why I should care. The same applies later on (e.g., "Node JS Language Module enhancements" tells me nothing. And we had similarly notable fixes for Python and Ruby.)

We will add the CHANGES to the bottom of the annouce message which will have a little more context about the Python and Node.js changes. I think for this release we are good about referencing to the CHANGES section.

For other features like conditional access logging there is a complete and very detailed section in the announce message. Ususally we didn't write a lot of text about a new variable we have added. I would suggest the link to the CHANGES in good for this release but should be changed for the next one.

I have linked the bullet list to sections of the docs/news to help with the context.

tippexs commented 2 months ago

@Jcahilltorre This is the CHANGE that must be added at the very bottom of the news-item page.

RST-Code:

**************
Full Changelog
**************

.. code-block:: none

  Changes with Unit 1.32.0                                         27 Feb 2024

    *) Feature: WebAssembly Components using WASI interfaces defined in
       wasi:http/proxy@0.2.0.

    *) Feature: conditional access logging.

    *) Feature: NJS variables access.

    *) Feature: $request_id variable contains a string that is formed using
       random data and can be used as a unique request identifier.

    *) Feature: options to set control socket permissions.

    *) Feature: Ruby arrays in response headers, improving compatibility
       with Rack v3.0.

    *) Feature: Python bytearray response bodies for ASGI applications.

    *) Bugfix: router could crash while sending large files. Thanks to
       rustedsword.

    *) Bugfix: serving static files from a network filesystem could lead to
       error.

    *) Bugfix: "uidmap" and "gidmap" isolation options validation.

    *) Bugfix: abstract UNIX socket name could be corrupted during
       configuration validation. Thanks to Alejandro Colomar.

    *) Bugfix: HTTP header field value encoding could be misinterpreted in
       Python module.

    *) Bugfix: Node.js http.createServer() accepts and ignores the "options"
       argument, improving compatibility with strapi applications, among
       others.

    *) Bugfix: ServerRequest.flushHeaders() implemented in Node.js module to
       make it compatible with Next.js.

    *) Bugfix: ServerRequest.httpVersion variable format in Node.js module.

    *) Bugfix: Node.js module handles standard library imports prefixed with
       "node:", making it possible to run newer Nuxt applications, among
       others.

    *) Bugfix: Node.js tarball location changed to avoid build/install
       errors.

    *) Bugfix: Go module sets environment variables necessary for building
       on macOS/arm64 systems.

nginx / unit-docs