BioDrop
BioDrop copied to clipboard
[DOCS] Make getting started more inclusive
Description
The Prerequisites; Installation Steps; and To Add Your Profile for a person who is truly 'new2tech' (and not necessarily a 'code-newbie') this is very daunting and a completely new language. Not inclusive for a person who is 'new2tech'
Screenshots

Additional information
Sign-posts to simple explanation resources (whatever type of media that maybe) that would help the person who is new2tech to be involved. After the person has reviewed the signposts, they can then ask for clarity if need be; and then choose to contribute. The Installation Steps rely on someone that has done this already and has experience of already doing this. For a person new to GitHub (and say again new2tech) they will not know how to do this; unless there is a working-example of how to do this.
It's great having you contribute to this project
Welcome to the community :nerd_face:If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often π€ . Any questions let us know.
I wonder if a link to a YouTube video showing these steps would be a good idea.
most definitely π sign posting to resources that explain these concepts in a simple way (so that a 10yr old could understand) would be very beneficial.
I would also suggest we have a Wiki that can have links to the various get started tutorials. Also a documentation part on the website where we can edit from GitHub?
I would like to work on this if the maintainers would allow.
I have created a basic file with links to resources to assist with downloading LinkFree please amend if anything is incorrect https://github.com/goobric/linkfreeInformation
I have created a basic file with links to resources to assist with downloading LinkFree please amend if anything is incorrect https://github.com/goobric/linkfreeInformation
This looks like a great start. I wonder if we should have it as a general document within the organisation that can be linked to from all repos (I don't see anything super specific to LinkFree although I only looked at it briefly so I might've missed something?) and I wonder if some of Eddie's github videos should also be included as reference material.
Agree with Emma
here is a very basic information source, directing users to resources that might be useful with regard to Downloading & Using LinkFree Thank you @emmalearnscode for help with the accessibility component
hi moderator of the 'Instructions for LinkFree' if it is okay, can the Instructions for LinkFree be amended please?
To Add Your Profile : this instruction should come after the Installation Steps, and before the Warning sentence; as the person following the instructions, hasn't yet created a Profile.
To Add Your Profile (can this be changed; imho I believe this reads better as an instruction)
in the 'public/data' directory, create a .json file, with your GitHub username ie 'eddiehub.json' replace eddiehub with your name, so the file is unique.
Thatβs a great point @goobric I just read through and it would definitely make sense to move that warning
please excuse my naivety, who has the responsibility to amend/update the instructions for the LinkFree project? Can I submit a PR with proposed alterations?
please excuse my naivety, who has the responsibility to amend/update the instructions for the LinkFree project? Can I submit a PR with proposed alterations?
Yes, you can make a PR. No one person/group is responsible for the instructions, everyone can contribute to improve them.
Hello, first-time contributor here! I came into this issue because I also had a problem with the "To Add Your Profile" session. I agree with @goobric that the instructions are not clear to someone new2tech (like me). I would suggest something similar to what he said: "In the data directory, create a .json file with the same name as your GitHub username. For example, if your GitHub username is eddiehub, create a file named eddiehub.json. This will ensure that the name is unique." I also want to point out that maybe we can avoid using abbreviations (like "i.e.") as they are not necessarily friendly to people whose first language is not English. I saw that @goobric added a commit, but I saw that the changes haven't been incorporated yet, probably because maintainers are busy. In any case, I hope this helps, and sorry for the long comment!