Skip to content

rc-REL-1364796: Update README.md — remove deprecation notice and Aspera content - #5

Merged
shivarajkamadod merged 2 commits into
mainfrom
rc-REL-1364796-readme-update
Aug 28, 2026
Merged

rc-REL-1364796: Update README.md — remove deprecation notice and Aspera content#5
shivarajkamadod merged 2 commits into
mainfrom
rc-REL-1364796-readme-update

Conversation

@shivarajkamadod

@shivarajkamadod shivarajkamadod commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Summary

Cleans up the README to reflect the current state of the project.

Changes

  • Removed deprecation blockquote at the top of the file (architect request — revert to previous state)
  • Removed (deprecated since Dec 5th, 2022)\ from the H1 heading
  • Removed all Aspera content — Aspera is no longer supported:
    • Entire \AsperaClientConfiguration\ section and its ToC entry
    • Aspera from the supported clients list and long path table
    • Aspera-specific demo step, \ITransferClientStrategy\ entry, \AsperaUncPathResolver\ note
    • \AsperaCredentials\ row from \RelativityFileShare\ table
    • \NodePageSize\ (Aspera Node API) from \GlobalSettings\ table
    • (Aspera-Only)\ qualifier from the change job data rate section
    • Aspera-specific wording in error retry and filter descriptions
  • .NET version: \4.6.2\ → \4.8.1\ (matches project target and App.config)
  • Visual Studio versions: added 2022
  • TransferMode valid value: \Fileshare\ only (matches \TransferMode.cs\ enum)
  • Json.NET binding redirect example: updated to \13.0.0.0\ / .NET 4.8.1 (matches App.config)

Test Evidence after SDK format updates:

image

…ra content

- Remove large deprecation blockquote and 'deprecated since Dec 5th, 2022' heading label
- Remove all Aspera references (Aspera no longer supported)
  - Remove AsperaClientConfiguration section and ToC entry
  - Remove Aspera from supported clients, long path table, demo steps
  - Remove ITransferClientStrategy Aspera entry
  - Remove AsperaUncPathResolver note from IRemotePathResolver
  - Remove AsperaCredentials from RelativityFileShare table
  - Remove NodePageSize (Aspera Node API) from GlobalSettings table
  - Update Change job data rate section (was Aspera-Only)
  - Update error retry descriptions to remove Aspera specifics
  - Update filter descriptions to remove Aspera references
- Update .NET version: 4.6.2 -> 4.8.1
- Update Visual Studio versions: add 2022
- Update TransferMode valid value: Fileshare only
- Update Json.NET binding redirect example: 6.0.0.0 -> 13.0.0.0
@shivarajkamadod
shivarajkamadod force-pushed the rc-REL-1364796-readme-update branch 2 times, most recently from 6204c5b to 07359e7 Compare August 25, 2026 17:06
Comment thread README.md
Comment thread README.md
@shivarajkamadod
shivarajkamadod force-pushed the rc-REL-1364796-readme-update branch from 07359e7 to 7731e77 Compare August 26, 2026 13:54
@shivarajkamadod
shivarajkamadod merged commit 6cd0c93 into main Aug 28, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants