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.

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

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

Open
MatheusXavier opened this issue Jan 8, 2024 · 5 comments
Open

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

MatheusXavier opened this issue Jan 8, 2024 · 5 comments
Assignees
Labels
documentation Needs a documentation update lowest Lowest priority May-Jun'24 May-June 2024 release proposal Proposal for a new functionality in Ocelot sample Ocelot samples as examples of complete feature web apps
Milestone

Comments

@MatheusXavier
Copy link

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:

  • A namespace is being declared in the Program class
  • The Program class is being declared
  • The Program class is implementing the Main method
  • Not using WebApplication.CreateBuilder

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
Copy link
Member

raman-m commented Jan 10, 2024

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... 🆗 ❔

@raman-m raman-m added proposal Proposal for a new functionality in Ocelot documentation Needs a documentation update sample Ocelot samples as examples of complete feature web apps Jan'24 January 2024 release labels Jan 10, 2024
@MatheusXavier
Copy link
Author

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
Copy link
Member

ggnaegi commented Jan 11, 2024

@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
Copy link
Member

raman-m commented Jan 11, 2024

@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 raman-m added Mar-Apr'24 March-April 2024 release and removed Jan'24 January 2024 release labels Mar 23, 2024
@raman-m raman-m added this to the March-April'24 milestone Mar 23, 2024
@raman-m
Copy link
Member

raman-m commented Apr 20, 2024

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 raman-m added lowest Lowest priority May-Jun'24 May-June 2024 release and removed Mar-Apr'24 March-April 2024 release labels Apr 25, 2024
@raman-m raman-m modified the milestones: March-April'24, May-June'24 Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Needs a documentation update lowest Lowest priority May-Jun'24 May-June 2024 release proposal Proposal for a new functionality in Ocelot sample Ocelot samples as examples of complete feature web apps
Projects
None yet
Development

No branches or pull requests

3 participants