ThreeMammals / Ocelot

.NET API Gateway
https://www.nuget.org/packages/Ocelot
MIT License
8.28k stars 1.63k forks source link

The Getting Started document could be updated for .NET 8 #1912

Closed MatheusXavier closed 2 months ago

MatheusXavier commented 7 months ago

Doc Update Suggestion

A little while ago I migrated my project to dotnet 8 and I noticed that the Getting Started documentation is a little outdated, for example:

Not that these points are serious problems, but I believe that the documentation could be updated.

During the migration I I implemented my Main class a little differently and published this article on medium to demonstrate my approach.

I am willing to make a PR if you fine folks think this kind of changes is welcome.

raman-m commented 7 months ago

Hi Matheus! Welcome to Ocelot world! 🐯

Nice article! Thanks you! Have you posted this article to LinkedIn network?


Not that these points are serious problems, but I believe that the documentation could be updated.

Not serious! It could be, because we support .NET 6+ only since November'23.

Have you ever thought in terms of backward compatibility? This old, legacy Program.Main startup approach is supported by .NET 6+ SDKs also... But Yes, because .NET 6+ app can have implicit entry point aka Top-level statements so it makes sense to upgrade the docs and samples apps.

If you have intention to contribute, I would ask you update all samples apps too... 🆗 ❔

MatheusXavier commented 7 months ago

Hello Raman!

Thank you!


Have you posted this article to LinkedIn network?

No, I have not, only on medium.


Have you ever thought in terms of backward compatibility?

Thinking about backwards compatibility, I don't think it will be a problem because we don't need to apply everything in the article and almost everything in it works in dotnet 6.


If you have intention to contribute, I would ask you update all samples apps too... 🆗 ❔

Ok, I'll update the samples apps and the getting started doc.

Can you create a new branch for me so I can work on it?

ggnaegi commented 7 months ago

@MatheusXavier you should fork the repo, then create your own branch in the forked repo. When you are ready, you can from there create a PR. image

raman-m commented 7 months ago

@MatheusXavier As @ggnaegi said, you have to fork Ocelot repo and create feature branch in your forked repo. More about our development process: Release Process

When you'll create a PR this feature ticket will be accepted. But you can go to develop right now because you are assigned. 😉 Pay attention that Samples require to setup Docker Desktop and run Docker locally. All projects have Dockerfile. Unfortunately, we have not added each Sample solution to Docker Compose project to have local Docker network when debugging and running. Have you ever worked with Docker and Docker Compose?

Good luck having much inspiration!

raman-m commented 4 months ago

Three months have passed!.. @MatheusXavier, where are you? You need to update your develop branch to be identical to head repo one! Now it has the diff. The diff must be zero, no changes at all.

Also I see the feature branch: 1912-update-docs-and-apps-samples But it has no much changes, very initial development. Why did you stop development on Jan 13? What's your plan of delivery?

FYI

The samples folder was changed much in PR #2045 . So, you have to rebase your feature branch! Or, create new branch from develop.

raman-m commented 2 months ago

You have the right to reopen this issue in the future if you come with a PR ready.