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

docs: Update Developer Setup to remove WinUtils step and include ScalaTest Configuration update. #2244

Merged
merged 4 commits into from
Jun 26, 2024

Conversation

sss04
Copy link
Contributor

@sss04 sss04 commented Jun 25, 2024

Related Issues/PRs

Updating the Developer Setup instructions to remove the WinUtils step (which is no longer needed), and adding a step to update the Run Configuration of ScalaTest. This update should get rid of the following bug that occurs when testing a freshly setup SynapseML:

Exception java.lang.IllegalAccessError: class org.apache.spark.storage.StorageUtils$ (in unnamed module @0x7f992c3a) cannot access class sun.nio.ch.DirectBuffer (in module java.base) because module java.base does not export sun.nio.ch to unnamed module @0x7f992c3a

What changes are proposed in this pull request?

Minor change updating Developer Setup

How is this patch tested?

Only a documentation change.

  • I have written tests (not required for typo or doc fix) and confirmed the proposed feature/bug-fix/change works.

Does this PR change any dependencies?

  • No. You can skip this section.
  • Yes. Make sure the dependencies are resolved correctly, and list changes here.

Does this PR add a new feature? If so, have you added samples on website?

  • No. You can skip this section.
  • Yes. Make sure you have added samples following below steps.
  1. Find the corresponding markdown file for your new feature in website/docs/documentation folder.
    Make sure you choose the correct class estimators/transformers and namespace.
  2. Follow the pattern in markdown file and add another section for your new API, including pyspark, scala (and .NET potentially) samples.
  3. Make sure the DocTable points to correct API link.
  4. Navigate to website folder, and run yarn run start to make sure the website renders correctly.
  5. Don't forget to add <!--pytest-codeblocks:cont--> before each python code blocks to enable auto-tests for python samples.
  6. Make sure the WebsiteSamplesTests job pass in the pipeline.

@sss04 sss04 requested a review from mhamilton723 as a code owner June 25, 2024 19:33
@acrolinxatmsft1
Copy link

Acrolinx Scorecards

A minimum total score of 80 is required.

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain customer trust in overall content quality.

Article Total score
(Required: 80)
Words + phrases
(Brand, terms)
Correctness
(Spelling, grammar)
Clarity
(Readability)
docs/Reference/Developer Setup.md 77 100 61 67

More information about Acrolinx

@acrolinxatmsft1
Copy link

Acrolinx Scorecards

A minimum total score of 80 is required.

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain customer trust in overall content quality.

Article Total score
(Required: 80)
Words + phrases
(Brand, terms)
Correctness
(Spelling, grammar)
Clarity
(Readability)
docs/Reference/Developer Setup.md 77 100 61 67

More information about Acrolinx

@acrolinxatmsft1
Copy link

Acrolinx Scorecards

A minimum total score of 80 is required.

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain customer trust in overall content quality.

Article Total score
(Required: 80)
Words + phrases
(Brand, terms)
Correctness
(Spelling, grammar)
Clarity
(Readability)
docs/Reference/Developer Setup.md 82 100 61 67

More information about Acrolinx

@sss04 sss04 changed the title Update Developer Setup to remove WinUtils step and include ScalaTest Configuration update. docs: Update Developer Setup to remove WinUtils step and include ScalaTest Configuration update. Jun 26, 2024
@mhamilton723 mhamilton723 merged commit 4c7f11f into microsoft:master Jun 26, 2024
3 of 4 checks passed
@sss04 sss04 deleted the shyamsai/devsetup branch June 26, 2024 23:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants