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

DOCS-#3904: Improving Modin README #3929

Merged
merged 24 commits into from
Jan 25, 2022
Merged

DOCS-#3904: Improving Modin README #3929

Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
797bcd7
DOCS-#3904: Improving Modin README
naren-ponder Jan 11, 2022
abfe6c2
omnisci change
naren-ponder Jan 11, 2022
5786ed2
first comment round
naren-ponder Jan 12, 2022
a77d66e
address some more comments
naren-ponder Jan 18, 2022
60ee81e
small grammar fix
naren-ponder Jan 21, 2022
a1aad8d
update rebase
naren-ponder Jan 21, 2022
9db68d8
development change
naren-ponder Jan 21, 2022
4703fbe
address another round and fix whitespace
naren-ponder Jan 21, 2022
10e4584
address comments 4
naren-ponder Jan 21, 2022
5a4144b
update README structure with proposed changes
naren-ponder Jan 21, 2022
ffce9a4
Add links at the end
naren-ponder Jan 21, 2022
aabc6d3
add modin engine configs
naren-ponder Jan 21, 2022
354e060
update Slack link
naren-ponder Jan 22, 2022
b31afff
Apply suggestions from code review 5
naren-ponder Jan 22, 2022
da7ea45
change bold to italics
naren-ponder Jan 22, 2022
85fac02
Apply suggestions from code review 6
naren-ponder Jan 22, 2022
d5e612a
fix some grammar and paragraph structure
naren-ponder Jan 22, 2022
39ed47e
restructure resources section
naren-ponder Jan 23, 2022
6d44ec7
some minor fixes
naren-ponder Jan 24, 2022
3d7b5a8
fix faq links
naren-ponder Jan 24, 2022
af88e42
add TLDR to faq
naren-ponder Jan 24, 2022
7cbbc01
fix broken links in documentation
naren-ponder Jan 24, 2022
7770a3a
fix some more links
naren-ponder Jan 24, 2022
8aeb23e
change section title
naren-ponder Jan 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update Slack link 
Signed-off-by: Naren Krishna <naren@ponder.io>
  • Loading branch information
@naren-ponder
naren-ponder committed Jan 24, 2022
commit 354e06067b14894c4d4170ef919c3d3515e83ba4
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<p align="center">
<a href="https://discuss.modin.org"><img alt="" src="https://img.shields.io/badge/discourse-forum-purple.svg?logo=discourse&logoColor=white" align="center"></a>
<a href='https://modin.org/slack.html'><img src='https://img.shields.io/static/v1?label=chat&logo=slack&message=Slack&color=brightgreen' alt='Slack' align="center"/></a>
<a href='https://join.slack.com/t/modin-project/shared_invite/zt-yvk5hr3b-f08p_ulbuRWsAfg9rMY3uA'><img src='https://img.shields.io/static/v1?label=chat&logo=slack&message=Slack&color=brightgreen' alt='Slack' align="center"/></a>
<a href="https://codecov.io/gh/modin-project/modin"><img src="https://codecov.io/gh/modin-project/modin/branch/master/graph/badge.svg" align="center"/></a>
<a href="https://github.com/modin-project/modin/actions"><img src="https://github.com/modin-project/modin/workflows/master/badge.svg" align="center"></a>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is it possible to add also link on conda-forge here?

Copy link
Collaborator

Choose a reason for hiding this comment

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

We've added links to conda-forge in the installation instructions. If we add an extra badge for conda-forge up in the top section, the badges will span across two lines, which doesn't look as great.

<a href="https://modin.readthedocs.io/en/latest/?badge=latest"><img alt="" src="https://readthedocs.org/projects/modin/badge/?version=latest" align="center"></a>
Expand Down Expand Up @@ -186,7 +186,7 @@ more information!
- [Documentation Link](https://modin.readthedocs.io/en/latest/)
- [Modin Examples + Tutorials](https://modin.readthedocs.io/en/latest/getting_started/examples.html)
- [Modin Talks + Blogs](https://modin.readthedocs.io/en/latest/getting_started/examples.html#talks-podcasts)
- [Modin Slack](https://modin.org/slack.html)
- [Modin Slack](https://join.slack.com/t/modin-project/shared_invite/zt-yvk5hr3b-f08p_ulbuRWsAfg9rMY3uA)
- [Modin Discourse](https://discuss.modin.org)
- [Modin GitHub Issues Page](https://github.com/modin-project/modin/issues)
- [Modin FAQs](https://modin.readthedocs.io/en/latest/getting_started/faq.html)
Expand Down