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

Adding tutorial on setting up package using template #418

Merged
merged 9 commits into from
Jun 19, 2024

Conversation

matt-graham
Copy link
Collaborator

Would potentially resolve #205

This adds a lightly edited (mainly removing references to workshop) version of the tutorial we used in the Festival of Digital Research & Scholarship workshop to the top-level of the repository along with some linking text to tutorial in README.md.

I also made a few small fixes to existing set up instructions in README.md that I noticed while adding link to tutorial.

@matt-graham matt-graham added the documentation Improvements or additions to documentation label Jun 13, 2024
Copy link
Member

@paddyroddy paddyroddy left a comment

Choose a reason for hiding this comment

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

I wrapped the tutorial.md file (not manually), you might want to check it still works

@matt-graham
Copy link
Collaborator Author

I wrapped the tutorial.md file (not manually), you might want to check it still works

I'm a hard👎 on wrapping Markdown. It makes it a pain to edit and given most editors will auto soft wrap I don't understand the need.

This reverts commit e2cb4d4.
@matt-graham
Copy link
Collaborator Author

I've reverted the wrapping commit on the basis that I would say we should await a consensus on #337 and if we decide to autowrap at some line length there we can apply it to the repository (including this file if merged) then.

@paddyroddy
Copy link
Member

I'm a hard👎 on wrapping Markdown. It makes it a pain to edit and given most editors will auto soft wrap I don't understand the need.

It's just consistent with the rest of this repo IMO. Personally, I don't understand why you wouldn't 🤷 I'll hold off reviewing as I find that file hard to read as it currently is.

Copy link
Member

@samcunliffe samcunliffe left a comment

Choose a reason for hiding this comment

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

🫐

@matt-graham
Copy link
Collaborator Author

The link checker is failing here as I've added a link to the tutorial to the templates pages in the documentation and it doesn't exist yet on the main branch.

@samcunliffe
Copy link
Member

samcunliffe commented Jun 19, 2024

The link checker is failing here as I've added a link to the tutorial to the templates pages in the documentation and it doesn't exist yet on the main branch.

Temporarily removing link-checker from the required checks....

@samcunliffe samcunliffe merged commit 411ff90 into main Jun 19, 2024
13 of 14 checks passed
@samcunliffe samcunliffe deleted the mmg/add-tutorial branch June 19, 2024 21:30
@samcunliffe
Copy link
Member

... readded it. And the test passes on main

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document next steps for the user once they run the tool
3 participants