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

DOC-783 Add hideClipboard functionality #1355

Merged
merged 7 commits into from
Jun 8, 2023

Conversation

nagesh161007
Copy link
Contributor

Describe the Change

This pull request introduces a new feature called "hideClipboard" in markdown files, which allows the copy button for code snippets to be hidden.

By default, the copy button will be displayed. However, if desired, users can override this default behavior by specifying the "hideClipboard" option when working with markdown files.

Setup test environment using jest and react testing library.

Added unit test cases for Pre component and added test step in Github CI/CD actions

Example

bash hideClipboard
Failed to update kubeadmControlPlane Connection timeout connecting to Kubernetes Endpoint
hide_copy_button

Review Changes

💻 Add Preview URL

🎫 Jira Ticket

@netlify
Copy link

netlify bot commented Jun 7, 2023

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 29cf415
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/6481e6ea6dc2d5000860b283
😎 Deploy Preview https://deploy-preview-1355--docs-spectrocloud.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 settings.

@karl-cardenas-coding karl-cardenas-coding marked this pull request as ready for review June 7, 2023 20:39
@karl-cardenas-coding karl-cardenas-coding requested a review from a team as a code owner June 7, 2023 20:39
@karl-cardenas-coding karl-cardenas-coding requested review from karl-cardenas-coding, rahulhazra97 and sudkul87 and removed request for a team June 7, 2023 20:39
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

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

@nagesh161007 I'm approving this PR because the changes look good. I have some minor suggestions for the README.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@github-actions
Copy link
Contributor

github-actions bot commented Jun 7, 2023

Images automagically compressed by Calibre's image-actions

Compression reduced images by 49.7%, saving 13.05 KB.

Filename Before After Improvement Visual comparison
assets/docs/images/hide_copy_button_example.png 26.24 KB 13.19 KB -49.7% View diff

344 images did not require optimisation.

@nagesh161007 nagesh161007 merged commit d5fbb22 into master Jun 8, 2023
@nagesh161007 nagesh161007 deleted the chore-hide-clipboard-feature branch June 8, 2023 14:52
sudkul87 pushed a commit that referenced this pull request Jun 8, 2023
* chore : add hideClipboard functionality

* Optimised images with calibre/image-actions

* chore : fix ci/cd

* chore : remove unsued variables in test case

* chore:fix review comments

* Optimised images with calibre/image-actions

* chore: remove white space

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
karl-cardenas-coding added a commit that referenced this pull request Jun 12, 2023
* docs: improve the intro

* Optimised images with calibre/image-actions

* Apply suggestions from code review round 1 - part 1

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: apply suggestions from code review round 1

* docs: typo

* docs: add basic and advanced

* docs: add Dockerfile customization

* docs:typo

* docs:typo again

* docs: add docker push

* docs: remove color highlight

* docs: language cleanup

* Apply suggestions from code review round 2

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: address feedback suggestions

* docs: add docker hub prereq

* Apply suggestions from code review round 3

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: apply feedback suggestions

* docs: update arguments

* docs: finishing touch

* docs: language cleanup

* docs: minor language fixes and updated URLs

* docs: update image and URL

* Optimised images with calibre/image-actions

* docs: minor Edge fixes

* docs: fixed indentation on advanced section #12

* docs: address bug-bash-session feedback

* docs: grammar fix

* Optimised images with calibre/image-actions

* docs: update metadescription

* docs: remove vi

* Optimised images with calibre/image-actions

* docs: language clean up

* docs:typo

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: add suggestions from review

* docs: fix conflict and change tabs

* docs: update the diagram

* Optimised images with calibre/image-actions

* DOC-783 Add hideClipboard functionality (#1355)

* chore : add hideClipboard functionality

* Optimised images with calibre/image-actions

* chore : fix ci/cd

* chore : remove unsued variables in test case

* chore:fix review comments

* Optimised images with calibre/image-actions

* chore: remove white space

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs: change tabs

* docs: add hideClipboard

* docs: typo

* Apply suggestions from code review

* docs: concept clarification and language fixes

* Optimised images with calibre/image-actions

* chore: retrigger build

* docs: updates based on CanvOS changes

* docs: final update

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: Nageshwara sairam <113401242+nagesh161007@users.noreply.github.com>
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.

2 participants