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

Outdated README instructions for serving break new workbench template #24

Closed
DanilaFe opened this issue Nov 14, 2024 · 5 comments
Closed

Comments

@DanilaFe
Copy link
Contributor

Hello! I'm trying to suggest some changes to bring the Chapel code up to date w.r.t. the latest release, and ran into trouble getting started. All is well now, but I thought I'd mention it here, and provide the error message in case someone else runs into the same issue.

The README.md file for this repo currently instructs running make serve to preview the lessons. This results in installing some Jekyll gems and generating a _site folder in the repository. However, since this lesson has been updated to the new carpentry template in #23, the Jekyll build does not give a "proper-looking" website (themes are missing and some markdown content is not correctly rendered).

Moreover, following the standard setup process for the carpentries workbench, running sandpaper::build_lesson in the folder causes the following error:

Error in UseMethod("xml_find_first") :
  no applicable method for 'xml_find_first' applied to an object of class "xml_document"

Deleting the Jekyll-generated _site fixed this problem (and sandpaper::build_lesson built everything just fine). However, perhaps the Makefiles and the README ought to be updated with the preview instructions?

@bkmgit
Copy link

bkmgit commented Nov 14, 2024 via email

@razoumov
Copy link
Member

Hi Daniel - thank you for the suggestion. I created a pull request with a suggested change #26 -- someone will need to review and hopefully approve it.

@razoumov
Copy link
Member

@DanilaFe Ok, I suggested the PR 26 to address this, and it did not pass the PR checks: "Error: Failed to CreateArtifact: Received non-retryable error: Failed request: (409) Conflict: an artifact with this name already exists on the workflow run"

I don't know which file caused this error. I simplified this PR with a new PR 28 to replace it, and I get the same error. I modified only two files there: Makefile and README.md, so apparently I am not at liberty to edit those two files. Suggestions?

@DanilaFe
Copy link
Contributor Author

Thank you @razoumov! I can't make sense of the error message either, unfortunately. It doesn't seem to me (scanning the CI configuration) that it makes use of the Makefile.

@tkphd
Copy link
Member

tkphd commented Nov 20, 2024

The Makefile is OK; this appears to have been an internal CI glitch. The checks do indeed pass.

Closed by #28.

@tkphd tkphd closed this as completed Nov 20, 2024
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

No branches or pull requests

4 participants