Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#2219 Documentation supporting .NET 8-9 #2258

Merged
merged 40 commits into from
Mar 27, 2025
Merged

#2219 Documentation supporting .NET 8-9 #2258

merged 40 commits into from
Mar 27, 2025
+4,654 −3,159

Conversation

raman-m
Copy link
Member

@raman-m raman-m commented Jan 31, 2025 •
edited
Loading

Closes #2219:3

Proposed

  • Updated documentation configuration and environment.
  • Updated Introduction docs.
  • Updated Features docs.
  • Partially updated Building Ocelot docs. Due to issues with CircleCI and the migration to GitHub Actions, the building process will be revised, and these docs must be reviewed and updated following the .NET 9 release.

@raman-m raman-m added documentation Needs a documentation update NET9 .NET 9 release labels Jan 31, 2025
@raman-m raman-m added this to the .NET 9 milestone Jan 31, 2025
@raman-m raman-m self-assigned this Jan 31, 2025
@raman-m raman-m changed the title #2219 Documentation in favor of .NET 8 and 9 #2219 Documentation supporting .NET 8 and 9 Jan 31, 2025
@raman-m raman-m changed the title #2219 Documentation supporting .NET 8 and 9 #2219 Documentation supporting .NET 8-9 Feb 28, 2025
@raman-m raman-m added the high High priority label Feb 28, 2025
raman-m added 22 commits March 20, 2025 14:12
@raman-m
#2217 Answer to How can I configure Ocelot programmatically?
d58d832
@raman-m
Update README.md
da9eddf
@raman-m
Review license and readme.
4b17e89 
Check new signing GPG key
@raman-m
Docs config & Update Introduction docs
a9ff528
@raman-m
Disable BddfyConfig
97b2b44
@raman-m
Update README.md
372fddb 
Keep images in the assets branch and read them from raw.githubusercontent.com
@raman-m
Delete images directory
4453389 
All images should be located in the ASSETS branch
@raman-m
Update workflows
28e5545
@raman-m
Disable icon embedding
60d6668
@raman-m
Update features A-C
97f28e1
@raman-m
Update Configuration feature doc:
591f53b 
Add schemas
Add Overview section
Organize sections
@raman-m
Configuration feature doc
252d169
@raman-m
remove namespace
8e5096c
@raman-m
Delegating Handlers feature
2b5840e
@raman-m
Dependency Injection feature
40219b4
@raman-m
Features E-K
12bab3e
@raman-m
Load Balancer feature
aab7aef
@raman-m
Logging feature vs Error Handling one
cebfa1f
@raman-m
Add Metadata sample
4ccaa7a
@raman-m
Metadata sample: JSON responder.
9224f89 
Serialize route metadata JSON to HTTP response body
@raman-m
Metadata sample: Rename to MetadataResponder
f92e3c2
@raman-m
Metadata sample: Test gzip & deflate encodings.
eff6e80 
Add OC-Route-Metadata header
@raman-m raman-m force-pushed the raman-m/2219-docs branch from 507e90a to 9235e59 Compare March 20, 2025 11:50
@raman-m raman-m force-pushed the raman-m/2219-docs branch from 208fcd6 to 541d68a Compare March 23, 2025 16:07
@raman-m raman-m requested review from RaynaldM and ggnaegi March 27, 2025 15:11
raman-m
raman-m commented Mar 27, 2025
View reviewed changes
Copy link
Member Author

@raman-m raman-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready for delivery ✔️

@raman-m raman-m merged commit 355cc33 into develop Mar 27, 2025
1 check passed
@raman-m raman-m deleted the raman-m/2219-docs branch March 27, 2025 15:16
@raman-m raman-m mentioned this pull request Mar 27, 2025
Closed
5 tasks
ggnaegi
ggnaegi reviewed Mar 27, 2025
View reviewed changes
Copy link
Member

@ggnaegi ggnaegi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job Raman...

@raman-m
Copy link
Member Author

raman-m commented Mar 27, 2025 •
edited
Loading

Current typos/issues in develop docs

  1. servicediscovery.html → Sample section: At the beginning, two phrases have the same meaning, so the first phrase must be removed, because it is old.
  2. websockets.html → SignalR section: The phrase "Note that standard Ocelot routing rules apply;..." could be moved and placed after JSON code block.
  3. PDF → The Table of Contents is broken:
  • All sections and chapters have references to the Page 7.
  • Page 9: The Table of Contents is empty.
  • Pages 14-15: Big Picture. Possibly after "2.1. Basic Implementation," there is a bug in RST code that disrupts the layout of all pages.
  • The PDF document contains only 17 pages, and that is very odd.
  1. To be found...

@raman-m
Copy link
Member Author

raman-m commented Mar 28, 2025

Useful Links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ggnaegi ggnaegi ggnaegi left review comments

@RaynaldM RaynaldM Awaiting requested review from RaynaldM

Assignees

@raman-m raman-m

Labels
documentation Needs a documentation update high High priority NET9 .NET 9 release
Projects
None yet
Milestone
.NET 9
Development

Successfully merging this pull request may close these issues.

.NET 9: Upgrade plan
2 participants
@raman-m @ggnaegi