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

Fix broken expansion boxes #346

Merged
merged 4 commits into from
Nov 1, 2023
Merged

Fix broken expansion boxes #346

merged 4 commits into from
Nov 1, 2023

Conversation

bkmgit
Copy link
Contributor

@bkmgit bkmgit commented Jul 25, 2023

Fixes #348
This is a fix for a formatting issue that prevents scp option appearing in the rendered web page. A related issue is #290

@github-actions
Copy link

github-actions bot commented Jul 25, 2023

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/datacarpentry/shell-genomics/compare/md-outputs..md-outputs-PR-346

The following changes were observed in the rendered markdown documents:

 05-writing-scripts.md | 27 ++++++++++++---------------
 md5sum.txt            |  2 +-
 2 files changed, 13 insertions(+), 16 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2023-11-01 09:32:33 +0000

github-actions bot pushed a commit that referenced this pull request Aug 7, 2023
Copy link
Contributor

@sstevens2 sstevens2 left a comment

Choose a reason for hiding this comment

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

This change looks great and I think should get merged ASAP.

One note is that solution boxes not inside another fenced div current don't render correctly. You may want to look at callout with the current fix to add an empty fenced div to fix in this issue in this PR.

@sstevens2
Copy link
Contributor

Note, I don't think is related closely #290 which is more on sftp alternatives to scp. It will fix #348 though.

Copy link
Contributor

@p-j-smith p-j-smith left a comment

Choose a reason for hiding this comment

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

Thanks @bkmgit for your first contribution! And thanks @sstevens2 for raising the issue and your review on this pr.

@bkmgit, as @sstevens2 suggested, please could you add a fenced div around your solution block to ensure it renders correctly.

Also, please could you edit your initial comment in this pr to add 'fixes #348' to it - this will link this pr to that issue and automatically close the issue once this pr is merged.

Thanks!

github-actions bot pushed a commit that referenced this pull request Oct 30, 2023
@p-j-smith
Copy link
Contributor

Looking again at this I think it would be better to use the spoiler div introduced in sandpaper 13.0 rather than solution.

Here's how it renders using the spoiler class:

scp-spoiler-div

I hope you don't mind @bkmgit that I pushed changes to use spoiler and update your branch with main, but as @sstevens2 said, I think it's good to get this fix merged sooner rather than later.

Thanks again for raising the issue and for your fix!

@p-j-smith p-j-smith self-assigned this Oct 30, 2023
@p-j-smith p-j-smith requested a review from vhmcck October 30, 2023 11:30
Copy link
Contributor

@vhmcck vhmcck left a comment

Choose a reason for hiding this comment

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

Hey Paul,
Thanks for doing this. It looks good on my end!
One last thing - shall we change abbreviations as you did in line 333 throughout for consistency?
I have marked the proposed changes as comments.
Cheers,
Valentina


### Uploading Data to your Virtual Machine with PSCP
### PCSP

If you're using a Windows PC without Git Bash, we recommend you use the *PSCP* program.
Copy link
Contributor

Choose a reason for hiding this comment

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

you are


If you're using a Windows PC without Git Bash, we recommend you use the *PSCP* program.
This program is from the same suite of tools as the PuTTY program we have been using to connect.

1. If you haven't done so, download pscp from [http://the.earth.li/~sgtatham/putty/latest/x86/pscp.exe](https://the.earth.li/~sgtatham/putty/latest/x86/pscp.exe)
1. If you haven't done so, download *PSCP* from [http://the.earth.li/~sgtatham/putty/latest/x86/pscp.exe](https://the.earth.li/~sgtatham/putty/latest/x86/pscp.exe)
Copy link
Contributor

Choose a reason for hiding this comment

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

you have not

@@ -388,16 +384,19 @@ $ scp [email protected]:/home/dcuser/shell_data/untrimmed_fastq/scripted_bad_rea

Remember that in both instances, the command is run from your local machine, we've just flipped the order of the to and from parts of the command.
Copy link
Contributor

Choose a reason for hiding this comment

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

we have

@bkmgit
Copy link
Contributor Author

bkmgit commented Oct 31, 2023

Thanks for the improvements. Sorry for delayed response. Changes seem fine.

@bkmgit
Copy link
Contributor Author

bkmgit commented Oct 31, 2023

scp is great for automation when you know where a file is. sftp is great when you want
to manually navigate the file system before transferring files. For most people starting
with the shell, sftp might be easier to use initially as it builds on commands they are familiar with. However, this is probably a separate change. Can make a further pull request to address this. Tools such as Globus may also be worth mentioning as scp/sftp are not great for large file transfers, though Globus is not available everywhere.

github-actions bot pushed a commit that referenced this pull request Nov 1, 2023
@p-j-smith p-j-smith merged commit 0119512 into datacarpentry:main Nov 1, 2023
3 checks passed
github-actions bot pushed a commit that referenced this pull request Nov 1, 2023
Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Nov 1, 2023
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Nov 7, 2023
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Nov 14, 2023
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Nov 21, 2023
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Nov 28, 2023
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Dec 5, 2023
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Dec 12, 2023
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Dec 19, 2023
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Dec 26, 2023
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Jan 2, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Jan 9, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Jan 16, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Jan 23, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Jan 30, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Feb 6, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Feb 13, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Feb 20, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Feb 27, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Mar 5, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
github-actions bot pushed a commit that referenced this pull request Mar 12, 2024
Auto-generated via {sandpaper}
Source  : 89ee5db
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-01 09:39:44 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0119512
Branch  : main
Author  : Benson Muite <[email protected]>
Time    : 2023-11-01 09:38:10 +0000
Message : Fix broken expansion boxes (#346)

* Fix broken expansion boxes

* Use 'spoiler' rather than 'solution' for the platform-specific upload instructions

* Use contraction `you're` for consistency

---------

Co-authored-by: Paul Smith <[email protected]>
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.

Transfering local to cloud drop-down menu broken
4 participants