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 documentation for deprecated components #2479

Merged
merged 1 commit into from Aug 23, 2023

Conversation

viktorrusakov
Copy link
Contributor

Description

Updates documentation for deprecated components to give more accurate replacement options.

Deploy Preview

Include a direct link to your changes in this PR's deploy preview here (e.g., a specific component page).

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please add wittjeff and adamstankiewicz as reviewers on this PR.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@netlify
Copy link

netlify bot commented Jul 27, 2023

Deploy Preview for paragon-openedx ready!

Name Link
🔨 Latest commit 162f425
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/64e5cbadd0a4c800080da5e1
😎 Deploy Preview https://deploy-preview-2479--paragon-openedx.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov
Copy link

codecov bot commented Jul 27, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (f4cfffa) 91.70% compared to head (162f425) 91.70%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2479   +/-   ##
=======================================
  Coverage   91.70%   91.70%           
=======================================
  Files         236      236           
  Lines        4219     4219           
  Branches     1021     1021           
=======================================
  Hits         3869     3869           
  Misses        346      346           
  Partials        4        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 3, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Aug 3, 2023

Thanks for the pull request, @viktorrusakov! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@mphilbrick211
Copy link

Hi @viktorrusakov! Please let me know if you have any questions regarding submitting your CLA form. If you are contributing as part of another organization, you'll need to be added to their entity CLA.

@adamstankiewicz
Copy link
Member

Hi @viktorrusakov! Please let me know if you have any questions regarding submitting your CLA form. If you are contributing as part of another organization, you'll need to be added to their entity CLA.

Hi @mphilbrick211, Viktor was previously under Raccoon Gang's CLA but he is no longer with Raccoon Gang. That said, he is still a Core Contributor and we believe he has signed an individual CLA form already. Perhaps he is falling into this camp now:

If you've signed an agreement in the past, you may need to re-sign.

@viktorrusakov When you get a chance, do you mind filling out the individual CLA form again?

@mphilbrick211
Copy link

Thanks, @adamstankiewicz, I appreciate the clarification, and apologies @viktorrusakov for not remembering you're a CC!

If you don't mind re-submitting the form, that would be great! If there's any issue, I can look into it for you.

@viktorrusakov
Copy link
Contributor Author

Hi @adamstankiewicz, @mphilbrick211! Thanks for the clarification, I totally forgot that there was something wrong with my CLA check. I've resubmitted the form just now, let me now if anything else is required from my side.

@mphilbrick211
Copy link

Hi @adamstankiewicz, @mphilbrick211! Thanks for the clarification, I totally forgot that there was something wrong with my CLA check. I've resubmitted the form just now, let me now if anything else is required from my side.

Hi @viktorrusakov! Did you get confirmation of your CLA going through? If not, I can check on it for you.

@viktorrusakov viktorrusakov force-pushed the vrusakov/update-deprecated-docs branch from a33047c to df746d8 Compare August 18, 2023 09:26
@viktorrusakov
Copy link
Contributor Author

Hi @mphilbrick211, no, I don't think so, I didn't receive any feedback after submitting the form and CLA check still fails after re-running it.

I've resubmitted the form just now just in case I made a typo somewhere last week.

@mphilbrick211
Copy link

Hi @mphilbrick211, no, I don't think so, I didn't receive any feedback after submitting the form and CLA check still fails after re-running it.

I've resubmitted the form just now just in case I made a typo somewhere last week.

Great, thanks, @viktorrusakov! I will check on Monday to make sure it's been processed.

@mphilbrick211
Copy link

Hi @viktorrusakov! I checked on your CLA status, and it has been received. Tomorrow, you should be able to rebase and your CLA check should turn green.

@viktorrusakov viktorrusakov force-pushed the vrusakov/update-deprecated-docs branch from eed4ec7 to 162f425 Compare August 23, 2023 09:04
@viktorrusakov
Copy link
Contributor Author

Thank you @mphilbrick211, it works now!

@viktorrusakov viktorrusakov merged commit 91f176b into master Aug 23, 2023
11 checks passed
@viktorrusakov viktorrusakov deleted the vrusakov/update-deprecated-docs branch August 23, 2023 09:39
@openedx-webhooks
Copy link

@viktorrusakov 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@edx-semantic-release
Copy link
Contributor

🎉 This PR is included in version 21.1.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

@edx-semantic-release
Copy link
Contributor

🎉 This PR is included in version 22.0.0-alpha.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

5 participants