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

[Docs] The configuration of a schema should contain a list of all required parameters #157

Open
froschdesign opened this issue Apr 14, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@froschdesign
Copy link
Contributor

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.

@alexander-schranz alexander-schranz added the documentation Improvements or additions to documentation label Apr 14, 2023
@alexander-schranz
Copy link
Member

alexander-schranz commented Apr 17, 2023

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 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
@froschdesign
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants