[DRIVERS-2693] User-facing Network Compression Drivers Documentation Created: 16/Aug/23 Updated: 01/Nov/23 |
|
| Status: | Implementing |
| Project: | Drivers |
| Component/s: | Docs |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | Alex Bevilacqua | Assignee: | Unassigned |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Epic Link: | Improve Awareness of Network Compressors for Drivers | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| Driver Changes: | Needed | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| Quarter: | FY24Q3 | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| Downstream Changes Summary: | Ensure Network Compression documentation is present. Network compression info should be clearly documented and easy to find by our users via a top-level section/tutorial in the docs. For teams that have existing documentation around this (such as on github.io,etc), they will need to take stock of what is documented and then move it into the current docs location (updating the content if necessary). For teams that work with Doc Team, file a DOCSP ticket. High priority for Q3.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Product Manager: | |
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Start date: | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| Driver Compliance: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Description |
|
Not all languages currently have user docs regarding network compressor configuration and usage.
These will be required for upstream links from Atlas (the Connect modal). |
| Comments |
| Comment by Tom Selander [ 22/Aug/23 ] |
|
Drivers Triage: There is no unified format for how all of the team docs look but the goal is that we want to ensure this information is obvious to the consuming user. For teams that have existing documentation around this, they will need to look at what exists and then move it into the current docs location (updating if necessary)
Tagging this for Q3 as this is a high priority and teams should triage and find time to slot this into their current quarterly plan. |