-
Couldn't load subscription status.
- Fork 91
Restructured readme and broke out optional info into supplementary topics #46
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
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.
Not reviewed all of it, but noticed the code in the README now seems to be for an old version of the SDK?
Yeah, I think before we review this readme it would worth updating it to latest |
|
Are you sure putting Getting started after library features? |
No - It doesn't have to be. I can reorder if you want. The "real" Quick Start is in the online docs anyway (which I am linking to) |
Would be good to review it next to the announcement copy as both are designed to use the same feature lists w/ samples. |
|
New arch-notes.md file is not correctly linked to the Readme. For instance where we are saying "Quix Streams is designed to be extended to multiple programming languages.". Probably Contribution Guide section could be another good place to link to the new file. |
|
Docs build including this branch is here: |
|
About removing "What is time series data" after "What is Quix Streams" section, there are some thoughts here in slack https://quixworld.slack.com/archives/C01U8DHH67J/p1677656326060989?thread_ts=1677218529.712249&cid=C01U8DHH67J If we return it to the main readme, I will keep it in the same position. This section only makes sense to improve the context of "What is Quix Streams". |
13d578c to
13efa52
Compare
and small typos in arch guidelines
and small typos in arch guidelines
5b7d9db to
c74a5c6
Compare
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.
The Readme.md regressed in several places talking about output and inputs, etc.
[Task/31413] - Fix README and CONTRIBUTING
Updated the READMDE so that the libraries features are more prominent and understandable with code samples to illustrate how they work
Also split out lower-priority information into supplementary topics. For example:
what-is-timeseries.md— many readers won't need this information so better to not let it clutter the main READMDE.mac-m1-m2-install.md— again, this is currently "workaround" documentation (also very lengthy) and wont concern many readers (on Windows, Linux, or Intel Mac)arch-notes.md— supplementary information that wont interest everyone.Additionally, the "Prepare your Kafka Cluster" section did not provide any information on how to prepare anything, rather it's purpose seemed to be simply to communicate the message "We use Kafka".
I reworked this section to provide basic instructions for a local Kafka install to help people test the library quickly.