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

Physically represent maintainership and documentation of machines #1347

Open
MatthewCroughan opened this issue Dec 15, 2019 · 6 comments
Open

Physically represent maintainership and documentation of machines #1347

MatthewCroughan opened this issue Dec 15, 2019 · 6 comments
Assignees

Comments

@MatthewCroughan
Copy link

@MatthewCroughan MatthewCroughan commented Dec 15, 2019

There should be QR codes and contact addresses for the maintainers of machines, and or information on how to get remote help with the machines.

For example, the Creality 3D Printers. I wish to be a maintainer of all 3. As well as me, I hope @ajlennon will join in on being a maintainer of them. We should then have information physically on the machines that tells people they can email us at a specific email, make an issue on github and-or message participating maintainers on Whatsapp or via email. I will be one of the maintainers that opts in for direct messaging.

This will be of great benefit to infrequent users of the space that need help when nobody is around, which happens every now and then.

@MatthewCroughan MatthewCroughan self-assigned this Dec 15, 2019
@ajlennon

This comment has been minimized.

Copy link
Contributor

@ajlennon ajlennon commented Dec 16, 2019

Yeah I'll sign up for that

@RiverMersey

This comment has been minimized.

Copy link

@RiverMersey RiverMersey commented Dec 23, 2019

Hi, here's another example QR code DoES might use...!
Rule_0_Do_not_be_on_fire

QR codes such as this can store a text field up to 300 characters long.

@RiverMersey

This comment has been minimized.

Copy link

@RiverMersey RiverMersey commented Dec 23, 2019

For this particular GitHub maintenance issue, my suggestion would be to write a static or dynamic web page that outlines the contact information needed for each machine. Dynamic might be preferable in that it could then allow the maintainers details to be shown on a shift basis dependant on time of day / day of week?

When that web page is ready for publication, copy the URL into the QR code generator website to design the QR code that then gets glued onto the machine.

As and when needed, the web page can be edited while the QR code remains the same.

@MatthewCroughan

This comment has been minimized.

Copy link
Author

@MatthewCroughan MatthewCroughan commented Dec 23, 2019

Well preferably we'd want to keep out of setting up any infrastructure even in the form of a webpage, and just use github for this. We can represent maintainers in the wiki. This ends up being quite a bit more dynamic as we can dynamically link many things together in the wiki as mentioned in #1349

This way we don't need a maintainer for a codebase and we can update these things openly with PRs or issues that directly interlink with the wiki in the form of github's markdown, the same way we cross reference issues.

The qr code generation should be standard and potentially automated, it should at least not have any reliance on internet connectivity. We can already make qr codes with qrencode. Additionally, this alternative website exists and is more preferable to any that require a signup https://www.the-qrcode-generator.com/. But if we want to make it look as good as the one that requires signup that'll have to wait until I make a nice script to set all that up, which I will get around to as I want to solve this issue quite badly.

@RiverMersey

This comment has been minimized.

Copy link

@RiverMersey RiverMersey commented Dec 23, 2019

Just noticed, https://www.qr-code-generator.com/qr-code-api/ has an API! Using this would of course break one of your rules of having to use a network connection to use the service. And it would likely also need to register an email that then gets spammed!
As I've not heard of your qrencode suggestion, I also research that. Having an output image that can be in the SVG format would be preferable as it could be scaled as required.

@MatthewCroughan

This comment has been minimized.

Copy link
Author

@MatthewCroughan MatthewCroughan commented Dec 23, 2019

No real issue using it if it works and exists now, it's quite a nice api. Let's do both.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.