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

Includes optional what3words address of the workshop venue #838

Merged
merged 3 commits into from
Oct 2, 2024

Conversation

pgmccann
Copy link
Contributor

@pgmccann pgmccann commented Sep 3, 2024

This change adds an optional what3words address field to the index page, providing organisers with another, user-friendly way of specifying the venue location.

Copy link

netlify bot commented Sep 3, 2024

Deploy Preview for workshop-template-previews ready!

Name Link
🔨 Latest commit 4f84ef4
🔍 Latest deploy log https://app.netlify.com/sites/workshop-template-previews/deploys/66fd1b141881ed0008fded96
😎 Deploy Preview https://deploy-preview-838--workshop-template-previews.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 configuration.

Copy link
Member

@tobyhodges tobyhodges left a comment

Choose a reason for hiding this comment

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

I like this suggestion, thank you @pgmccann. Do you think people will understand why/when using W3W might be beneficial, or should we provide more explanation of the circumstance sin which the additional, more precise location info could be helpful?

@pgmccann
Copy link
Contributor Author

pgmccann commented Oct 2, 2024

I think that's a good question.

The comment next to the variable assignment in the header currently contains about as much information as the others around it - I'm not sure a longer description is appropriate for an optional value. I also fear that an explanation in the text of the page might get in the way of the location information itself.

Would a simple

(find out more about what3words)

after the location information in the page suffice?

@tobyhodges
Copy link
Member

tobyhodges commented Oct 2, 2024

Please could you add a description of the new variable on the Customization page? I don't think that page is widely known, but it is the appropriate place for a more detailed description of the various configuration options.

[Edit: source file for that page in the template: https://github.com/carpentries/workshop-template/blob/gh-pages/_extras/customization.md]

Moves the what3words variable to sit alongside the other optional
variables, for consistency with the documentation.
Copy link
Member

@tobyhodges tobyhodges left a comment

Choose a reason for hiding this comment

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

Fantastic, thank you @pgmccann. (Thanks also for your patience while you waited for me to review your pull requests 🥲)

@tobyhodges tobyhodges merged commit 496d672 into carpentries:gh-pages Oct 2, 2024
6 checks passed
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