Update release notes for R8.0.0. #173
Conversation
There was a problem hiding this comment.
Reviewable status: 0 of 5 files reviewed, 1 unresolved discussion (waiting on @jrobble)
docs/docs/Release-Notes.md line 30 at r1 (raw file):
<h3>Updates</h3> - [[#1693](https://github.com/openmpf/openmpf/issues/1693)] Add property to enable/disable SAS in AzureSpeech
THis is bad
There was a problem hiding this comment.
Reviewed 5 of 5 files at r2, all commit messages.
Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @brosenberg42 and @jrobble)
docs/docs/Release-Notes.md line 9 at r2 (raw file):
<h3>Documentation</h3>
Unless this breaks protocol, I think the Documentation section should come after the sections describing new features/functionality. Otherwise, it is out of context and a user doesn't know what these terse descriptions are referring to.
docs/docs/Release-Notes.md line 12 at r2 (raw file):
- Created a new [OpenID Connect Guide](OpenID-Connect-Guide/index.html). - Updated the [Admin Guide](Admin-Guide/index.html) and [User Guide](User-Guide/index.html) to remove `/workflow-manager` from the Workflow Manager base URL. The Admin Guide includes a section for new the Hawtio web
The Admin Guide includes a section for the new Hawtio web console.
docs/docs/Release-Notes.md line 49 at r2 (raw file):
<h3>Component API Updates</h3>
This section could use a sentence to explain why these were removed.
docs/docs/Release-Notes.md line 57 at r2 (raw file):
- Each component's `descriptor.json` now requires an `algorithm.trackType` field. This is used by the Workflow Manager to determine the kind of tracks that may be generated by the component (e.g. `FACE`, `TEXT`, `CLASS`, etc.). This now
This is now used...
docs/docs/Release-Notes.md line 116 at r2 (raw file):
tracks you can provide a list of valid values. For example, `CLASSIFICATION=car;truck;bus`. - The [Trigger Guide](Trigger-Guide/index.html) goes into more detail and provides an example of a pipeline with multiple speech-to-text stages. `TRIGGER` is the used to select which speech-to-text algorithm is executed based on
Remove 'the' between 'is' and 'used' -- 'TRIGGER' is used...
docs/docs/Release-Notes.md line 140 at r2 (raw file):
- This new component utilizes [CLIP](https://github.com/openai/CLIP) to classify images using the 80 COCO classes, 1000 ImageNet classes, or a list of user-provided classes. It can run on a CPU or GPU and make calls to an NVIDIA Triton
It can run on a CPU or GPU, and can make calls to ...
There was a problem hiding this comment.
Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @brosenberg42 and @clnowacki)
docs/docs/Release-Notes.md line 9 at r2 (raw file):
Previously, clnowacki wrote…
Unless this breaks protocol, I think the Documentation section should come after the sections describing new features/functionality. Otherwise, it is out of context and a user doesn't know what these terse descriptions are referring to.
So far I've always made sure to list the docs first. It's been that way in prev. release notes. The reason is that it usually provides an outline of the biggest features and changes to the core. Yeah, a reader would have to keep reading the individual sections that follow to learn more.
I try to list the doc changes in order of importance, and also just the individual sections in the same order.
docs/docs/Release-Notes.md line 12 at r2 (raw file):
Previously, clnowacki wrote…
The Admin Guide includes a section for the new Hawtio web console.
Done.
docs/docs/Release-Notes.md line 49 at r2 (raw file):
Previously, clnowacki wrote…
This section could use a sentence to explain why these were removed.
I moved the "Packaging and Deployment" section above this one since that change was the main motivator. I also added a sentence to provide context.
docs/docs/Release-Notes.md line 57 at r2 (raw file):
Previously, clnowacki wrote…
This is now used...
Done.
docs/docs/Release-Notes.md line 116 at r2 (raw file):
Previously, clnowacki wrote…
Remove 'the' between 'is' and 'used' -- 'TRIGGER' is used...
Done.
docs/docs/Release-Notes.md line 140 at r2 (raw file):
Previously, clnowacki wrote…
It can run on a CPU or GPU, and can make calls to ...
Done.
There was a problem hiding this comment.
Reviewed 4 of 4 files at r3, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @brosenberg42)
There was a problem hiding this comment.
Reviewed 1 of 5 files at r2, 4 of 4 files at r4, all commit messages.
Reviewable status:
…f.github.io into release-notes-8.0
* Completed Health Check and Roll Up sections.
There was a problem hiding this comment.
Reviewed 7 of 7 files at r6, all commit messages.
Reviewable status:
3 participants
Issues:
Related PRs:
This change is