ThreeMammals / Ocelot

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

#1731 Docs for 20.0 release #1754

Closed raman-m closed 11 months ago

raman-m commented 11 months ago

Fixes #1731

This is the major update of the documentation for the current 20.0 release.

Proposed Changes

I guess, most interesting things to look at are:

raman-m commented 11 months ago

@ggnaegi FYI The Coveralls.io badge will be hidden on README page until we fix this. :yum:

Do you approve this? Something else?

ggnaegi commented 11 months ago

@ggnaegi FYI The Coveralls.io badge will be hidden on README page until we fix this. :yum:

Do you approve this? Something else?

Yes, until we introduce sonarqube 😊

raman-m commented 11 months ago

@ggnaegi Do you approve? We're very close to releasing v 20.0.1 with this docs. As a rest of work, I need to add make.bash to have ability to build docs on Linux machines. Current make.bat allows to build docs on Windows machine only.

ggnaegi commented 11 months ago

@ggnaegi Do you approve? We're very close to releasing v 20.0.1 with this docs. As a rest of work, I need to add make.bash to have ability to build docs on Linux machines. Current make.bat allows to build docs on Windows machine only.

@raman-m Sounds good to me. Why "-" instead of "^" ?

raman-m commented 11 months ago

@ggnaegi commented Sounds good to me. Why "-" instead of "^" ?

All features have been defined as sections with =, and some pages had the next level ^ (subsubsections), which is wrong because the next sublevel after sections is - (subsections).

More here: reST Sections

ggnaegi commented 11 months ago

Ok, reviewing the docs :-)

I would be up for the GraphQL bit, but with https://github.com/ChilliCream/graphql-platform, not graphql.net.

I have some experience with HotChocolate, since I implemented GraphQL for a customer.

this .net server is imho better and Michael (the owner) is a member of the GraphQL Technical Steering Committee.

But that's my opinion.

raman-m commented 11 months ago

@ggnaegi commented I would be up for the GraphQL bit, but with https://github.com/ChilliCream/graphql-platform, not graphql.net.

I am not a fun to integrate custom libraries, except direct references to official libs. Let's discuss GraphQl later, plz!

ggnaegi commented 11 months ago

@ggnaegi commented I would be up for the GraphQL bit, but with https://github.com/ChilliCream/graphql-platform, not graphql.net.

I am not a fun to integrate custom libraries, except direct references to official libs. Let's discuss GraphQl later, plz!

Mmh. Graphql.NET is not the official implementation by the way. There is no official implementation.

raman-m commented 11 months ago

@ggnaegi left a code review comment: Great job!

Thanks!

I have written two comments, but we should send a positive message to the contributors.

I've fixed issues! Please, approve, if no other issues.

raman-m commented 11 months ago

@RaynaldM Hey, Ray! One more approval please!

raman-m commented 11 months ago

@RaynaldM Good morning, France! 😊