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

[BD-46] feat: added the "Edit this page" button #2604

Merged
merged 5 commits into from
Sep 15, 2023
Merged

[BD-46] feat: added the "Edit this page" button #2604

merged 5 commits into from
Sep 15, 2023

Conversation

PKulkoRaccoonGang
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang commented Sep 7, 2023 •
edited

Description

  • added the "Edit this page" button,
  • added logic for this button.

Issue

Deploy Preview

Paragon site documentation

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.

@openedx-webhooks
Copy link

openedx-webhooks commented Sep 7, 2023 •
edited

Thanks for the pull request, @PKulkoRaccoonGang!

When this pull request is ready, tag your edX technical lead.

@openedx-webhooks openedx-webhooks added the blended PR is managed through 2U's blended developmnt program label Sep 7, 2023
@netlify
Copy link

netlify bot commented Sep 7, 2023 •
edited

✅ Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 7e5c7e1
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/65042cc94b593400080c8e1f
😎 Deploy Preview https://deploy-preview-2604--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.

@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as draft September 7, 2023 16:12
@PKulkoRaccoonGang PKulkoRaccoonGang mentioned this pull request Sep 7, 2023
Closed
@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as ready for review September 7, 2023 16:21
@codecov
Copy link

codecov bot commented Sep 7, 2023 •
edited

Codecov Report

Patch coverage has no change and project coverage change: +0.12% 🎉

Comparison is base (b39a6a4) 91.69% compared to head (7e5c7e1) 91.81%.
Report is 14 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #2604      +/-   ##
==========================================
+ Coverage   91.69%   91.81%   +0.12%     
==========================================
  Files         235      235              
  Lines        4214     4217       +3     
  Branches     1021     1020       -1     
==========================================
+ Hits         3864     3872       +8     
+ Misses        346      341       -5     
  Partials        4        4

see 3 files with indirect coverage changes

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

@viktorrusakov viktorrusakov linked an issue Sep 8, 2023 that may be closed by this pull request
"Edit this page" CTA on Paragon docs site #2533
Closed
@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as draft September 8, 2023 12:01
@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as ready for review September 11, 2023 10:53
PKulkoRaccoonGang
PKulkoRaccoonGang commented Sep 11, 2023
View reviewed changes
www/src/templates/component-page-template.tsx Outdated
@@ -139,7 +142,10 @@ export default function PageTemplate({
)}
<div className="d-flex justify-content-between align-items-start">
<h1 className="mb-4">{mdx.frontmatter.title}</h1>
<LeaveFeedback />
<Stack direction="horizontal" gap={3}>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I decided not to use ButtonGroup, since the buttons are not displayed very well visually

@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as draft September 13, 2023 13:15
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/edit-page-btn branch 2 times, most recently from b2e528f to e5db3f6 Compare September 13, 2023 14:57
@adamstankiewicz
Copy link
Member

@PKulkoRaccoonGang It may also be a good idea to render the "Edit this page" CTA at the bottom of the page contents similar to how we show the "Leave feedback" in both spots. What do you think?

adamstankiewicz
adamstankiewicz reviewed Sep 13, 2023
View reviewed changes
www/src/templates/component-page-template.tsx Outdated Show resolved Hide resolved
www/src/components/PageEditBtn/index.tsx Outdated Show resolved Hide resolved
www/src/components/PageEditBtn/constants.js Outdated Show resolved Hide resolved
PKulkoRaccoonGang
PKulkoRaccoonGang commented Sep 14, 2023
View reviewed changes
Copy link
Contributor Author

@PKulkoRaccoonGang PKulkoRaccoonGang left a comment

Choose a reason for hiding this comment

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

@adamstankiewicz please take a look again. Currently, on component pages, we have a link to the "Edit this page" next to all the "Leave Feedback" links. We will add the “Edit this page” link in a separate pull request. Thank you!

www/src/components/PageEditBtn/constants.js Outdated Show resolved Hide resolved
www/src/components/PageEditBtn/index.tsx Outdated Show resolved Hide resolved
@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as ready for review September 14, 2023 07:51
@viktorrusakov viktorrusakov mentioned this pull request Sep 15, 2023
Closed
@viktorrusakov viktorrusakov merged commit b761187 into openedx:master Sep 15, 2023
11 checks passed
@openedx-webhooks
Copy link

@PKulkoRaccoonGang 🎉 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.2.0 🎉

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
Reviewers

@viktorrusakov viktorrusakov viktorrusakov approved these changes

@monteri monteri Awaiting requested review from monteri

@adamstankiewicz adamstankiewicz Awaiting requested review from adamstankiewicz

@bydawen bydawen Awaiting requested review from bydawen

Assignees
No one assigned
Labels
blended PR is managed through 2U's blended developmnt program released on @alpha released
Projects
No open projects
2U Blended Project
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

"Edit this page" CTA on Paragon docs site
6 participants
@PKulkoRaccoonGang @openedx-webhooks @adamstankiewicz @edx-semantic-release @bydawen @viktorrusakov