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.

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

SNOW-1320543 Merge modin docs into snowpark-python repo #1461

Merged
merged 5 commits into from
Apr 30, 2024

Conversation

sfc-gh-vbudati
Copy link
Contributor

Please answer these questions before submitting your pull requests. Thanks!

  1. What GitHub issue is this PR addressing? Make sure that there is an accompanying issue to your PR.

    Fixes SNOW-1320543

  2. Fill out the following pre-review checklist:

    • I am adding a new automated test(s) to verify correctness of my new code
    • I am adding new logging messages
    • I am adding a new telemetry message
    • I am adding new credentials
    • I am adding a new dependency
  3. Please describe how your code solves the related issue.

    Adding the modin/Snowpark pandas docs under docs/source/modin. The autogenerated files should reside under docs/source/modin/pandas-api. Added a section for Snowpark pandas in docs/source/index.rst.

@sfc-gh-vbudati sfc-gh-vbudati added documentation Improvements or additions to documentation NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md labels Apr 30, 2024
@sfc-gh-vbudati sfc-gh-vbudati requested review from a team as code owners April 30, 2024 17:14
@sfc-gh-lmukhopadhyay
Copy link
Contributor

Is there a way we can view the docs locally?

Copy link
Contributor

@sfc-gh-nkumar sfc-gh-nkumar left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Copy link
Contributor

@sfc-gh-nkrishna sfc-gh-nkrishna left a comment

Choose a reason for hiding this comment

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

Can you also change the CODEOWNERS file to only have the Snowpark pandas team for /docs/modin_api_coverage/* and /docs/source/modin/*?

.github/CODEOWNERS Outdated Show resolved Hide resolved
@sfc-gh-vbudati
Copy link
Contributor Author

@sfc-gh-lmukhopadhyay you can run the following:

cd docs
make clean; make html
open -a "Google Chrome" build/html/index.html

There's more info in the docs/README.md file

@sfc-gh-nkrishna updated codeowners

Copy link
Contributor

@sfc-gh-nkrishna sfc-gh-nkrishna left a comment

Choose a reason for hiding this comment

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

LGTM! :shipit:

Copy link
Contributor

@sfc-gh-helmeleegy sfc-gh-helmeleegy left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for taking this on!

.github/CODEOWNERS Show resolved Hide resolved
@sfc-gh-vbudati sfc-gh-vbudati merged commit 9e8e764 into main Apr 30, 2024
26 checks passed
@sfc-gh-vbudati sfc-gh-vbudati deleted the vbudati/SNOW-1320543-merge-modin-docs branch April 30, 2024 22:32
@github-actions github-actions bot locked and limited conversation to collaborators Apr 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants