pinot-contrib / pinot-docs

Apache Pinot Documentation
23 stars 151 forks source link

Edits to the FAQ pages as part of site review #213

Closed matthewhelmke closed 1 year ago

matthewhelmke commented 1 year ago

This PR contains edits to the FAQ pages. The PR is an improvement, but not ideal. Most FAQs should be ephemeral, lasting only until the information can be cleaned up and documentation can be updated in appropriate places to incorporate it. The exception is for information that isn't right for documentation but is useful in the long term, such as questions of the "Why?" variety that explain design decisions.

Right now, the info here is at risk of being missed by users who only look at the regular docs pages and don't open the FAQ.

All this PR does is clean up the language on existing pages, it does not yet move the information.

matthewhelmke commented 1 year ago

There are multiple pages with "general" FAQ topics. In round 2, let's move all the info we can into the main docs and condense all these pages and the topical pages into one page, reserved for only the newest questions and answers and as a temporary home until further research allows that info to also be moved.

matthewhelmke commented 1 year ago

I had to rename a page from "genaral.md" to "general.md". I think I got all the references, but will look to be sure.