manticoresearch
manticoresearch copied to clipboard
manticoresoftware
Improve settings reference in the manual
This is a continuation of the discussion started in this issue https://github.com/manticoresoftware/manticoresearch/issues/663#issuecomment-981323957
The task is to improve https://manual.manticoresearch.com/References , in particular different server settings.
➤ Sergey Nikolaev commented:
Thank you. I'm planning to continue reviewing the doc next week.
Hi @benwills
Sorry for the late reply. I've put my comments to the doc https://docs.google.com/spreadsheets/d/17wFUCUtA76G4GcLRPTmbNRml1rn2mg9Vy29yye9KxhU/edit#gid=0
My turn to apologize for the late reply. I've answered and updated all of the fields in the sheet, and updated the HTML version of the table here: https://benwills.com/manticore-settings/
Hi @benwills
I've commented what I could in the spreadsheet. Let's think what we can do to:
- integrate all you've done to https://manual.manticoresearch.com/References
- and make it more maintainable
Do you think it will work if you put it as a json (or a set of jsons) to directory "Settings" in https://github.com/manticoresoftware/manticoresearch/tree/master/manual ? Then the workflow will be:
- once we add a new setting we'll add it to the json too
- we'll change https://manual.manticoresearch.com/References so it's partly generated from the json (not sure yet it what format)
- you can generate your HTML version from there too
- if you (or anyone else) find some issue you just create a PR to update the json, we then review it, approve and merge
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. Feel free to re-open the issue in case it becomes actual.
![stale[bot] avatar](https://avatars.githubusercontent.com/in/1724?v=4 "Published by a pub.dev verified publisher"){kind=small}
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. Feel free to re-open the issue in case it becomes actual.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. Feel free to re-open the issue in case it becomes actual.