Open dougaitken opened 6 years ago
I think US should be USA. "US" or "United States" are commonly understood, but to me more ambiguous, and sounds almost like it could be Micronesia or Mexico.
I think if we're going to clean this up and make the Region field something from a predefined list, then we don't really need both region fields any more (the short one in the readme, and the possibly longer one in the company profiles). We can now take data out of the company profiles and stick it on the main page of the site pretty easily, so we can delete this column from the readme.
Anything we do here is going to require a good bit of manual cleanup, though. And of course the only way to get people to stick to a convention is to enforce it, so we would add more bot checks too.
I think it would be worth doing though - if we can come up with a good scheme here, then it will make a nice filter on the main page of the site.
Looking at the data in the "short region" field in the readme, here is what we have now:
And in the "Region" field in the company profiles:
Hi @dougaitken and @nylen, thanks for starting this conversation which is really worthwhile.
1) I agree that USA sounds good.
2) Do you think we could use the following convention for the region field? 1 country = country 2+ countries in the same region = region 2+ regions = worldwide
So, for example, if the company has employees in 1 country, eg the UK, then we put UK in the region field. If they have employees in 2 countries, eg the UK and Germany, then we put Europe. If they have employees in the UK and US, then we put Worldwide. Does that make any sense?? Lol I don't know if I've just made it more complex! Let me know!
3) With regard to the naming of regions, whilst I have an intuitive feel as to which regions I would use, I decided to take a look at the UN Statistical Devision's method, which is as follows:
Africa Northern America Latin America & the Caribbean Asia Europe Oceania (this includes Australia)
I quite like this. Let me know what you think?
4) Also, @nylen I like your suggestion that we could put the region in the company profile and then repeat that in the Readme file. Have I understood you correctly? Please correct me if I'm wrong! Thank you guys
Wow, sorry about the mis-clicks there.
I quite like this. Let me know what you think?
I like it, except I think we should split out "Latin America" and "Caribbean" because together that is very long.
Let's simplify a bit further.
Region can be 1 country (USA), 1 region, or a list of multiple regions, or Worldwide.
If there are, let's say, 3 or more regions, then we'll keep the original list in the data here, but collapse this down to Multiple
on the main page. The site can show the full list of regions on the company profile page.
And yes, we'll remove the Region column from the readme, but still show it on the main page of the website via magic.
I think this is workable. In a little while I'll post a list of what I think needs to be done to make this happen.
Sounds good @nylen. Sorry if this is a really stupid question, but what's the difference between the main page and the readme that you've noted? So, we're removing the Region column from the readme, but it's still on the main page and company profile? Thanks 👍
The difference is that we can make any page of the site say whatever we want, as long as the data comes from somewhere. For now it mostly matches the format of the input files (main readme and company profiles), but it doesn't have to.
The site is automatically generated by code that parses the data out of the readme and the company profiles, and then reconstructs it in the format we want for the website. Again right now this format is basically the same as the input data, but it doesn't have to be.
In this case, we'll leave the region info in each company profile, clean it up for all profiles, and remove it from the readme, so that it only has to be written and updated once by us. Then we'll use that code to copy the region from each company profile to the main page of the site.
In short: it takes some preparatory work, but we can let the robots do the boring, repetitive tasks like copying data, as much as possible.
Nice nice, I understand now thank you! :smiley:
I'll post a list of what I think needs to be done to make this happen
Hi @nylen This looks good to me!
Thank you!:smiley:
Yes to both of those questions (move the extra text to the "Remote Status" field, and indicate the new rules for regions in our template files).
Great @nylen! So, just to reiterate, we need to do the following (in this order of priority?):
I've left out the validation code action to show the companies not adhering to the new region rules, because I assume this will be so many of them anyway 😂 and since it will be such a manual process, maybe it's not super necessary. But if yourself or someone else could write that code quickly, maybe this would be helpful?
Please let me know what you think! I'm happy to have a shot at changing the rules in the template files and slowly chipping away at the manual edits 😄 Thank you
Sounds good. I'm thinking having the validation code in place, but leaving it as optional, would be useful in order to be able to generate a list of remaining issues whenever we want it. Are you able to run the existing validation code on your computer?
Definitely don't let that keep you from getting started though!
For context @Nirvikalpa108 - the readme list was the main list previously, James did the work to make it fancy and live on the website so we can move things away from that main list.
Ideally, everything lives in the company profile, we can then use that data if needed.
Thanks for your thoughts on this Amina!
Sounds great @nylen. I should be able to run the validation code. If I have any problems, I'll let you know, thank you 😃 Thank you so much for giving me this context @dougaitken, you're a star! I really appreciate it! 😊
Hey guys, so here is a draft of the language I propose to put in the Contributing Guidelines and the Company Profiles - example.md pages so that contributors know what to put in the region field. If it's rubbish, no worries at all, it's just a first draft! I appreciate all your feedback! :smiley:
Contributing Guidelines Number 5 - If you adhere to the protocol for listing the countries or regions for remote positions (as explained in the company profile - insert link)
Do we want to remove the asterix saying that this is optional and make it a requirement? I think it should be a requirement given it would improve the site's functionality (eg the search function) and I think that's why this issue #485 exists, but let me know if I've misunderstood.
Do you want to list the rule itself in the Contributing Guidelines or just link to it in the company profile page? Do you think contributors will follow the link and read it?
Company Profiles - example.md Region Where are remote employees accepted? List either 1 country (eg USA), 1 region (eg North America), a list of multiple regions, or Worldwide.
Here is the list of regions: Africa North America Latin America Caribbean Asia Europe Oceania (this includes Australia)
If there are 3 or more regions they can be listed on the company profile page, but noted as Multiple on the main page.
Guys, this advice for the company profile page seems really long compared to the guidance for the other sections. This is just a first shot. Keen to get your thoughts. Once we're happy with wording I'll do a PR to submit changes. Thank you!:sunglasses:
Hey guys, so here is a draft of the language I propose to put in the Contributing Guidelines and the Company Profiles - example.md pages so that contributors know what to put in the region field. If it's rubbish, no worries at all, it's just a first draft! I appreciate all your feedback! :smiley:
Contributing Guidelines Number 5 - If you adhere to the protocol for listing the countries or regions for remote positions (as explained in the company profile - insert link)
Do we want to remove the asterix saying that this is optional and make it a requirement? I think it should be a requirement given it would improve the site's functionality (eg the search function) and I think that's why this issue #485 exists, but let me know if I've misunderstood.
Do you want to list the rule itself in the Contributing Guidelines or just link to it in the company profile page? Do you think contributors will follow the link and read it?
Company Profiles - example.md Region Where are remote employees accepted? List either 1 country (eg USA), 1 region (eg North America), a list of multiple regions, or Worldwide.
Here is the list of regions: Africa North America Latin America Caribbean Asia Europe Oceania (this includes Australia)
If there are 3 or more regions they can be listed on the company profile page, but noted as Multiple on the main page.
Guys, this advice for the company profile page seems really long compared to the guidance for the other sections. This is just a first shot. Keen to get your thoughts. Once we're happy with wording I'll do a PR to submit changes. Thank you!:sunglasses:
I don't think we should include the full details about this in the contributing guidelines. We can link to them from there instead. Also, our end goal here is that the automated check for the Region field is enabled and required, so let's make it required.
So, we could change the contributing guidelines from this:
- If you submit the company with the regions that are accepted for remote positions (US only? Worldwide? Specific timezones?) *
to this:
- If you submit the company with the regions that are accepted for remote positions (for more details see the instructions in the example company profile).
Don't forget the pull request template text too.
There, we could just change this line in the pull request template:
Region details any restrictions to applicants based on geography
to something like this:
Region details the geographic regions in which this company's employees can reside. For more details see the instructions in the example company profile.
Now we need to fully document this new feature, and I think the example company profile is a good place to do that. It's ok with me if this section is longer than the rest. Here's a shot at it, continuing on from what you posted in your previous comment:
Where are remote employees accepted? List either 1 country (eg USA), 1 region (eg North America), a list of multiple regions, or Worldwide.
See the UN Statistical Division's country codes for a list of accepted countries.
The list of accepted regions is based on the UN Statistical Division's region codes, on the same page:
USA
North America, Latin America, Caribbean
Worldwide
Thanks @nylen, this looks great to me! Happy to go ahead and make the PRs for this. Just want to check if @dougaitken has any changes? Thanks! 😃
Let's do this @Nirvikalpa108! We can tweak on the PR if needed
Great, thanks @dougaitken. PR submitted 😃 let me know if I've done anything wrong! Thanks!
We prefer to work with remote team members in these timezones: UTC-8 to UTC-2.
In this case the extra text is in the "Remote status" section of the company profile.
I'm still happy with this approach, just pointing to a concrete example of what we discussed above and confirming that it will work well.
Great 👍
Here is an example that maybe wouldn't translate so well into just a list of countries: https://github.com/remoteintech/remote-jobs/blob/master/company-profiles/hashicorp.md#region (from #521)
Hmm, that is a good point @nylen. I wonder if we could look at linking to the regions section of the profile and either using a plain link text or pulling in the data for the company.
Or maybe "specific countries"? if it isn't an obvious region match? 🤔
For the Hashicorp example above, and for others, it could work reasonably well to do a hybrid approach:
This way we can let companies describe their region requirements accurately, but still have some pieces of structured data to enable a filter.
Here is another example where this approach could work well, but just listing "USA and India" wouldn't really be good enough (from #550):
I thought the "example regions" which were in the Over submission might work well -https://github.com/remoteintech/remote-jobs/pull/549#pullrequestreview-225173210
Then there could be one shown, but for search, it could search the other regions?
Yeah, that works. Those regions came from our example profile which is based on the previous discussion on this issue.
Let's get the data in place first, then we can figure out the details of how the search works.
Hi @dougaitken can I work on this issue, I am a full stack developer from India and currently an undergrad at IIT . Could you please assign it to me?
@jainendra001 As I mentioned in another Issue - before assigning any Issues, I would like possible contributors to discuss their solution in the Idea for enhancements.
As you can see, this Issue has a long and complex history to try and get the "regions" to work well in the spirit of the list. Any solution will be fully discussed here before any PR should be opened.
is this still open ?
This topic is still in discussions. There have been improvements over the years but nothing solid to account for the varied ways companies hire in a distributed fashion.
To allow for better matching and locations, we need to have predefined options for "region".
For example. For global reach, the default should be
Worldwide
. I made the first major change of this in #175As mentioned in #480, we don't have a defined option for United States / US / USA.
I mainly use
US
but I'm open to discussing from Americans about what they'd use most often.If a company is limited to one country, then that should be listed, otherwise, we could use options like Worldwide, APAC, Europe, US (USA), Africa.
I don't know what would be best / easiest. Either splitting via continent or region so I'd love to open this up for discussion