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.

Sign up for GitHub

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

Jump to bottom

Migrate the contents of TLS.md into README.md #927

Merged
merged 2 commits into from
Aug 28, 2024
Merged

Migrate the contents of TLS.md into README.md #927

merged 2 commits into from
Aug 28, 2024

Conversation

vax-r
Copy link
Contributor

@vax-r vax-r commented Aug 20, 2024 •
edited by enjoy-binbin
Loading

Migrate the contents in TLS.md into TLS sections including building,
running and detail supports. TODO list in the TLS.md is almost done
except the implementation of benchmark support is still not the best
approach which should migrate to hiredis async mode.

Closes #888

@vax-r
Migrate the contents of TLS.md into README.md
c13f17c 
Migrate the contents in TLS.md into TLS sections including building,
running and detail supports. TODO list in the TLS.md is almost done
except the implementation of benchmark support is still not the best
approach which should migrate to hiredis async mode.

Signed-off-by: I Hsin Cheng <richard120310@gmail.com>
@codecov Codecov
Copy link

codecov bot commented Aug 20, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.47%. Comparing base (76ad8f7) to head (b290374).
Report is 38 commits behind head on unstable.

Additional details and impacted files 
@@             Coverage Diff              @@
##           unstable     #927      +/-   ##
============================================
+ Coverage     70.17%   70.47%   +0.30%     
============================================
  Files           112      114       +2     
  Lines         61490    61744     +254     
============================================
+ Hits          43151    43516     +365     
+ Misses        18339    18228     -111

see 35 files with indirect coverage changes

zuiderkwast
zuiderkwast reviewed Aug 23, 2024
View reviewed changes
Copy link
Contributor

@zuiderkwast zuiderkwast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Did you move all content of TLS.md? If yes, then also delete TLS.md. The todo list belongs in github issues, not in the md files.

zuiderkwast
zuiderkwast approved these changes Aug 28, 2024
View reviewed changes
Copy link
Contributor

@zuiderkwast zuiderkwast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good, let's merge this. I'll take care of deleting the TLS.md file, so we don't have duplicated information around.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@zuiderkwast
Apply suggestions from code review
b290374 
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
@zuiderkwast zuiderkwast merged commit 6172907 into valkey-io:unstable Aug 28, 2024
45 of 46 checks passed
zuiderkwast added a commit to zuiderkwast/placeholderkv that referenced this pull request Aug 28, 2024
@zuiderkwast
Delete TLS.md and update tests/README.md and top-level README.md abou…
dc5d779 
…t tests

Most of the content of TLS.md has already been copied to README.md in valkey-io#927.

The description of how to run tests with TLS is moved to tests/README.md.

Descriptions of the additional scripts runtest-cluster, runtest-sentinel and
runtest-module are added in tests/README.md.

Links to tests/README.md and src/unit/README.md are added in the top-level
README.md along with a brief overview of the `make test-*` commands.

Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
@zuiderkwast zuiderkwast mentioned this pull request Aug 28, 2024
Merged
@zuiderkwast zuiderkwast added the documentation Improvements or additions to documentation label Aug 28, 2024
zuiderkwast added a commit that referenced this pull request Aug 28, 2024
@zuiderkwast
Delete TLS.md and update README.md about tests (#960)
25dd943 
Most of the content of TLS.md has already been copied to README.md in
#927.

The description of how to run tests with TLS is moved to
tests/README.md.

Descriptions of the additional scripts runtest-cluster, runtest-sentinel
and runtest-module are added in tests/README.md.

Links to tests/README.md and src/unit/README.md are added in the
top-level README.md along with a brief overview of the `make test-*`
commands.

Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
madolson pushed a commit that referenced this pull request Sep 2, 2024
@vax-r @zuiderkwast @madolson
Migrate the contents of TLS.md into README.md (#927)
ee79f17 
Migrate the contents in TLS.md into TLS sections including building,
running and detail supports. TODO list in the TLS.md is almost done
except the implementation of benchmark support is still not the best
approach which should migrate to hiredis async mode.

Closes #888

---------

Signed-off-by: I Hsin Cheng <richard120310@gmail.com>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Co-authored-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
madolson pushed a commit that referenced this pull request Sep 2, 2024
@zuiderkwast @madolson
Delete TLS.md and update README.md about tests (#960)
815e855 
Most of the content of TLS.md has already been copied to README.md in
#927.

The description of how to run tests with TLS is moved to
tests/README.md.

Descriptions of the additional scripts runtest-cluster, runtest-sentinel
and runtest-module are added in tests/README.md.

Links to tests/README.md and src/unit/README.md are added in the
top-level README.md along with a brief overview of the `make test-*`
commands.

Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
madolson pushed a commit that referenced this pull request Sep 3, 2024
@vax-r @zuiderkwast @madolson
Migrate the contents of TLS.md into README.md (#927)
cb2fa03 
Migrate the contents in TLS.md into TLS sections including building,
running and detail supports. TODO list in the TLS.md is almost done
except the implementation of benchmark support is still not the best
approach which should migrate to hiredis async mode.

Closes #888

---------

Signed-off-by: I Hsin Cheng <richard120310@gmail.com>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Co-authored-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
madolson pushed a commit that referenced this pull request Sep 3, 2024
@zuiderkwast @madolson
Delete TLS.md and update README.md about tests (#960)
be7f15c 
Most of the content of TLS.md has already been copied to README.md in
#927.

The description of how to run tests with TLS is moved to
tests/README.md.

Descriptions of the additional scripts runtest-cluster, runtest-sentinel
and runtest-module are added in tests/README.md.

Links to tests/README.md and src/unit/README.md are added in the
top-level README.md along with a brief overview of the `make test-*`
commands.

Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zuiderkwast zuiderkwast zuiderkwast approved these changes

@lilpoozie2005 lilpoozie2005 lilpoozie2005 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
Valkey 8.0
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Migrate TLS.md into README.md
3 participants
@vax-r @zuiderkwast @lilpoozie2005