search

dunglas / vulcain

🔨 Fast and idiomatic client-driven REST APIs.
https://vulcain.rocks
GNU Affero General Public License v3.0
3.51k stars 106 forks source link

Clear up inconsistency in documentation of production-readiness of the Gateway Server #67

Closed steef-paqt closed 4 months ago

steef-paqt commented 4 years ago

While reading the documentation, I stumbled on this inconsistency in the documentation.

On the readme.md it says:

A reference, production-grade, implementation gateway server is also available in this repository.

While on the linked page (Install The Gateway Server), it says about the Gateway server:

The Gateway Server is still experimental

So what is it? Either it is "experimental" or it is "production-grade". So one of these wordings should be changed.

Or it is somehow both, but some clarification on "why" would be in order in that case.

dunglas commented 4 years ago

Younes right. We have to clarify.

It is stable enough to be used in production (it will not crash, and behaves properly). But it's still a 0.x version, the spec itself and the configuration format of the server can still (and will) change often.