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

New member process #38

Open
joeroe opened this issue Jan 22, 2021 · 2 comments
Open

New member process #38

joeroe opened this issue Jan 22, 2021 · 2 comments

Comments

@joeroe
Copy link
Member

joeroe commented Jan 22, 2021

In the current version of the website, new members can sign up by editing members.tsv, re-knitting index.Rmd and submitting a pull request. In the new version of the website (which I think we've decided in principle to use – see #9), they would have to create a new .md file in content/members/ and submit a pull request.

I've since learned that hugo can generated pages from data files (JSON or delimited text) so going back to something like the previous workflow is possible (without the re-knitting step of course). But it also occurs to me that both ways could be off-putting to potential members who aren't very comfortable with git, or just editing a live website, and give the impression that prior knowledge of the tools we're using is some sort of test for entry. I can think of a few other ways of doing it (assuming we go with the new hugo setup) and would like to think about which is the most accessible option:

  1. Create <new member>.md and submit a pull request
    • Pros: YAML is easy to understand and edit; you can "Add a file" directly on GitHub and it will guide you on how to submit a PR
    • Cons: No easy way to provide a template for new files on GitHub, as far as I know
  2. Edit <new_member_template.md> and submit a pull request
    • Pros: As for 1, plus easy to see what information is required
    • Cons: Would need some sort of automated workflow for regenerating the template after it's used
  3. Edit members.csv or members.tsv and submit a pull request
    • Pros: Easy to "Edit a file" directly on GitHub and easy to see what information is required
    • Cons: GitHub's editor doesn't do anything special with delimited files, so it's not hard to mess up the commas/tabs
  4. Edit members.json and submit a pull request
    • Pros: As for 3, plus GitHub's editor has syntax highlighting for JSON
    • Cons: JSON syntax isn't particularly human-friendly
  5. None of the above; use another signup method (e.g. by email) and rely on maintainers to update the website
    • Pros: No prior knowledge expected of new members
    • Cons: More work for website maintainers

Currently I think 3 is probably the friendliest. But whichever one we choose, I think it would also be a good idea to:

  1. Have step-by-step instructions on how to sign up on the website and in the README.md
  2. Provide an alternative route that doesn't require using git at all (e.g. filling in a form that creates a issue)
@MartinHinz
Copy link
Collaborator

Being not so familiar with hugo at the moment, I would see an option 6, kind of merging 2, 3 and 4, using yaml, like in the suggestion for data templates from the hugo help.

  1. Editing a <new_member_template.yaml> and submit a pull request
  • Pros: Easy to "Edit a file" directly on GitHub and easy to see what information is required
  • Cons: Probably like 2, but maybe there is a solution for this...?

What do you think?

@joeroe
Copy link
Member Author

joeroe commented Jan 30, 2021

That sounds good, except I don't think hugo recognises .yaml files alone as content? I tried that it at one point, but I could be wrong.

@joeroe joeroe mentioned this issue Feb 3, 2021
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

2 participants