-
Notifications
You must be signed in to change notification settings - Fork 1
Delete testimonials from index.md #471
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
Conversation
WalkthroughRemoved the Testimonials rubric block from Changes
Sequence Diagram(s)(omitted — change is a simple documentation edit and does not alter runtime control flow) Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
5639f2b to
c577293
Compare
Removed testimonials section from documentation - let's leave marketing to the webpages.
c577293 to
dbe9077
Compare
Hi. We don't think the webpages do a great job here and beyond. Until this situation will significantly improve, the removal isn't too applicable? -- https://cratedb.com/database
|
I don't oppose removing marke-ty stuff from tech documentation, if the website marketing is not good, we don't fix it in the docs, separations of concerns imo |
|
Hey @amotl, I actually thought we were totally aligned about removing marketing speak from the docs, and that the purpose of the docs is to educate users on how to use and get maximum value out of the product? You also wrote that here: "Get rid of promotional or marketing language that is occasionally slipping in through the influx of material from other sources. Documentation should be rather dry than yappy.". Isn't this aligned 100% with that? Or did I misunderstand something? I believe we agree that the Overview page should guide people to the various sections of the docs and give a general introduction to the content, agree? I think there is more to do, but wanted to start with something non-controversial :-). Btw, for maximal credibility I don't think having a quote from a former employee is appropriate - irrespective on the timing of quote and employment. I'm quite convinced that should be removed in any case. I also don't think these 2 quotes have any meaningful effect on our marketing results tbh. So if that's really a problem to solve in the docs, we need to align on a totally different approach and direction. In summary, until we agree to do marketing in docs, I think we should remove this and move towards the agreed(?) direction: Docs are technical, descriptive, helpful and educate our users to get maximum value out of our product. Thoughts? |
|
Hi. We think it's a good idea to remove any marketing speak and other yapping from technical parts of the documentation and webpages, AI-based or not. Having two concise quotes at this spot, or another one, doesn't exactly contradict this idea, specifically because those quotes very much relay technological excellency without much ado? |
|
Appreciate the feedback 🙏. I do have one thought about potentially adding an "About" page - sometime in the future - that could be a a summary of the main features for those that lands directly here and want to get the high level technical feature overview - perhaps mostly consisting of the content from the current "Feature" overview page and a summary of the product web pages. But that requires more coordination and thinking about what should be there versus the Feature overview page. |
surister
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM


Summary of the changes / Why this is an improvement
Removed testimonials section from documentation - let's leave marketing to the webpages.
Preview
https://app.readthedocs.org/projects/cratedb-guide/builds/30180094/