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

datacarpentry/image-processing #46

Closed
8 of 9 tasks
zkamvar opened this issue Apr 10, 2023 · 9 comments
Closed
8 of 9 tasks

datacarpentry/image-processing #46

zkamvar opened this issue Apr 10, 2023 · 9 comments
Labels
early transition Lesson maintainers have indicated that this lesson can transition early lesson A Carpentries Lesson To Transition status: in progress This label is for lessons that are currently being processed, but still have issues

Comments

@zkamvar
Copy link
Contributor

zkamvar commented Apr 10, 2023

tracking issues for https://github.com/datacarpentry/image-processing/

episodes/02-image-basics.md:1004 [missing anchor]: [Accessing Metadata](#viewing-metadata)
index.md:23 [missing file]: [this detailed list](_extras/prereqs.md)
index.md:29 [missing file]: [make sure you have the software and data required](setup.md)
@zkamvar zkamvar added run pending Lessons that have not yet been tested locally status: in progress This label is for lessons that are currently being processed, but still have issues lesson A Carpentries Lesson To Transition and removed run pending Lessons that have not yet been tested locally labels Apr 10, 2023
@zkamvar zkamvar added the early transition Lesson maintainers have indicated that this lesson can transition early label Apr 12, 2023
zkamvar added a commit that referenced this issue Apr 13, 2023
@uschille
Copy link

I noticed that on the Summary and Setup page some callout and solution blocks are not properly rendered.

@uschille
Copy link

uschille commented Apr 14, 2023

I think the above is due to the formatting/indenting in the original markdown.

I found a few other similar things:

  • 03-skimage-images.md
    • Callout-box "Loading images with imageio: Read-only arrays": original markdown is missing a >
    • Link "In [the Image Basics episode" has an extra [
  • 07-thresholding.md and 08-connected-components.md
    • alt text for images appearing in {} under some images

These are my bad for not formatting the markdown properly...

There are few other links which have an extra [ throughout the lesson.

I can fix these directly in the lesson after the transition.

Thanks for all the work @zkamvar! I'm impressed 🙌

@zkamvar
Copy link
Contributor Author

zkamvar commented Apr 18, 2023

Thank you for spotting these!

The extra [ and the floating attributes after the images are 100% my parser's fault and I will look into them.

zkamvar added a commit that referenced this issue Apr 18, 2023
zkamvar added a commit to datacarpentry/image-processing that referenced this issue Apr 18, 2023
@zkamvar
Copy link
Contributor Author

zkamvar commented Apr 18, 2023

Indeed, the problems are linked to how {pegboard} treats these things. They are affecting other lessons, so it's important for me to fix them now:

carpentries/pegboard#119
carpentries/pegboard#120

@zkamvar
Copy link
Contributor Author

zkamvar commented Apr 19, 2023

I've addressed these in carpentries/pegboard#121

The trailing alt text is partially a symptom of the fact that Kramdown is much more permissive than Pandoc.

zkamvar added a commit that referenced this issue Apr 25, 2023
This will address the setup wonkiness in #46
@zkamvar
Copy link
Contributor Author

zkamvar commented Apr 25, 2023

I noticed that on the Summary and Setup page some callout and solution blocks are not properly rendered.

I just figured out why this is not processing correctly: it's because the translated blocks have an indent of two spaces when they needed 3. I've fixed this issue in 17c55fc.

Note that the solutions blocks are now more buoyant (so they connect with the previous div and they may obscure some text. To prevent this, add an empty div like in https://github.com/swcarpentry/python-novice-inflammation/blob/5bee17dcf3f6416f949816fc5e2207935bd80330/learners/setup.md?plain=1#L44-L48:

:::::::::::::::::::::::::::::::::::::::: {.empty-div style="margin-bottom: 50px"}


<!-- This div is intentionally empty to allow the solution to float alone-->


::::::::::::::::::::::::::::::::::::::::

@zkamvar
Copy link
Contributor Author

zkamvar commented Apr 25, 2023

I will be working to fix the floating solution or implementing a similar accordion class in the future, but no time for it now, unfortunately :(

zkamvar added a commit to datacarpentry/image-processing that referenced this issue Apr 25, 2023
@zkamvar
Copy link
Contributor Author

zkamvar commented Apr 25, 2023

A note about the release of dc/image-processing

We had technical issues with this release due to network errors. During
the push to main, we had the remote unexpectedly hang up.

To resolve this, Zhian manually ran the rest of the script starting from
where it left off (detailed below)

note that steps marked with (oops) are steps that Zhian should have
performed at a given time, but did later.

  1. opened the functions.R file and scrolled to the definition for
    setup_github()
  2. start R and run source("functions.R")
  3. provision the five parameters
    • path <- "release/datacarpentry/image-processing"
    • owner <- "datacarpentry"
    • repo <- "image-processing"
    • action <- "close-pr.yaml" (oops)
    • .token <- askpass::askpass() and paste the release token (oops:
      several failed attempts with system() and callr())
  4. run lines 468 through 480
  5. run default <- "gh-pages" (because by then the default had changed)
  6. run line 489 (oops)
  7. run lines 516 through 552 (force push and protect main branch)
  8. run lines 555 through 576 (oops: see note 1)
  9. run lines 516 through 552

note 1: step 9 did not work because I had not previously set my action
variable. Thus, when it failed, it failed in a state where the gh-pages
branch was already checked out and cleaned, so it continued to fail on
git rm -rf .. I switched to the shell and manually added the action
file to the branch, staged, committed, and force-pushed just in time
for it to be provisioned ahead of the build workflow.

This WAS a successful run, but it did require manual intervention.

@zkamvar
Copy link
Contributor Author

zkamvar commented Apr 25, 2023

This has been completed in 04a1570

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
early transition Lesson maintainers have indicated that this lesson can transition early lesson A Carpentries Lesson To Transition status: in progress This label is for lessons that are currently being processed, but still have issues
Projects
None yet
Development

No branches or pull requests

2 participants