You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It is very nice that each adapter has its own example for the configuration. In addition, each configuration should list the required parameters.
It should also be mentioned that these are only examples (maybe with default values) and the values for the parameters may differ on the own system.
The text was updated successfully, but these errors were encountered:
Think I will do this in an own adapters documentation. The Getting Started should concentrate to get things started as fast as possible. If some buddy want deeper drive into the specific adapters I think it make sense to have a docs for every adapter, where we maybe could also document internals, how a Index configuration is mapped to the server schema.
alexander-schranz
changed the title
The configuration of a schema should contain a list of all required parameters
[Docs] The configuration of a schema should contain a list of all required parameters
Apr 17, 2023
The Getting Started should concentrate to get things started as fast as possible.
This is a good idea, but unfortunately the requirements for this introduction are not specified. It seems to be no problem for you to use Docker, but I would not automatically transfer this to everyone else.
Therefore my suggestions:
add a section to the end of the page with the headline "Learn More"
add one or more links to the adapters in this section
define the steps and the requirements for the Getting Started tutorial at the beginning of the page
add a note in the requirements to the "Learn more" section
I think this should prepare the reader for what is to come or what the requirements are and where the alternatives can be found.
In principle, I welcome a distraction-free entry without being sent to another side, but if there are requirements, then they should be clearly stated. Alternatives should also be pointed out and when it is at the end.
It is very nice that each adapter has its own example for the configuration. In addition, each configuration should list the required parameters.
It should also be mentioned that these are only examples (maybe with default values) and the values for the parameters may differ on the own system.
The text was updated successfully, but these errors were encountered: