[gsoc25] Added blog post for firmware upgrader project#134
[gsoc25] Added blog post for firmware upgrader project#134nemesifier merged 6 commits intomasterfrom
Conversation
nemesifier
left a comment
There was a problem hiding this comment.
On track, see my comments below.
I'd suggest to try removing some bloat and be more direct in some passages, I found a number of typos and broken syntax/formatting, please read and review the text line by line in full making sure these issues are fixed.
|
|
||
| Over the past three months, I had the opportunity to work on my Google | ||
| Summer of Code project under the guidance of Federico Capoano (nemesifier) | ||
| <https://github.com/nemesifier>, Aryaman (Aryamanz29) |
| features address common pain points that network administrators face: | ||
| uncertainty about upgrade progress, inability to stop problematic | ||
| upgrades, and lack of granular control over which devices to upgrade in | ||
| large deployments. |
There was a problem hiding this comment.
You are mentioning the key pain points, I think using a list would allow faster reading. I'd try to reduce the amount of words. Less is more.
|
|
||
| The solution uses WebSocket connections to deliver real-time progress | ||
| updates directly to the admin interface, eliminating the need for manual | ||
| page refreshes. Progress tracking is implemented at multiple levels - from |
There was a problem hiding this comment.
let's avoid hyphens which are too chatgpty, use commas instead.
|
|
||
| The mass upgrade filtering system integrates with OpenWISP's existing | ||
| device group and location management, allowing administrators to target | ||
| specific subsets of devices with surgical precision. |
There was a problem hiding this comment.
After reading this section I think we'd be better of to moving this info to each feature subsection below. Let's go straight to the point and avoid sections without images as people don't like blobs of texts.
| targeting, such as "Access Points in Building A" or "Edge devices in the | ||
| European region". | ||
|
|
||
| **Use Cases**: - **Staged Rollouts**: Upgrade devices gradually by |
| You can follow the development process and explore the implementation | ||
| details in the following pull requests: | ||
|
|
||
| - `how upgrade progress for single upgrade operations in real time |
| Current state | ||
| ------------- | ||
|
|
||
| We are maintaining the ``gsoc25`` branch of openwisp-firmware-upgrader |
| My Experience | ||
| ------------- | ||
|
|
||
| Working on the OpenWISP firmware upgrader during GSoC has been an |
There was a problem hiding this comment.
| Working on the OpenWISP firmware upgrader during GSoC has been an | |
| Working on `OpenWISP Firmware Upgrader <https://github.com/openwisp/openwisp-firmware-upgrader>`__ during GSoC has been an |
| - `Allow cancelling firmware upgrade operations | ||
| <https://github.com/openwisp/openwisp-firmware-upgrader/pull/329>`_ | ||
| - `Allow mass upgrade by their group or location | ||
| <https://github.com/openwisp/openwisp-firmware-upgrader/pull/343>`_ |
There was a problem hiding this comment.
Let's mention the docs updates too
There was a problem hiding this comment.
@youhaveme9 is this supposed to be a list?
I ask you to fully read the blog post line by line and check the formatting and the output
The header image you are proposing is inconsistent with what we're using, we need to maintain consistency as always. I will give you instructions in the chat.
Please take care of the QA checks, running yarn prettify should be enough.
| The firmware upgrader enhancements address key pain points network | ||
| administrators face: | ||
|
|
||
| - **Uncertainty about upgrade progress** - No real-time feedback |
There was a problem hiding this comment.
Punctuation is weird:
| - **Uncertainty about upgrade progress** - No real-time feedback | |
| - **Uncertainty about upgrade progress**: No real-time feedback. |
Please apply the same suggestion to the whole article.
| .. image:: {static}/images/blog/gsoc25/firmware-upgrader/mass-upgrade-by-group-and-location.gif | ||
| :alt: Mass Upgrade by Group and Location | ||
|
|
||
| Mass upgrade operations now support precise device targeting through |
There was a problem hiding this comment.
Please let's link the PRs in their respective sections. It's ok to also have a summary at the end.
Not sure if other blog posts did the same, I will check, but it makes it easier for readers to quickly find the github PR while reading about the feature.
Let's not link gsoc25 because it won't exist anymore once it's merged.
No description provided.