near-in-minutes / frontend

NEAR in Minutes is a NEAR-COOP (NEAR Community Owned and Operated Project) that invites you to binge-watch lessons about the NEAR platform in your favorite language.
https://near-in-minutes.com
0 stars 0 forks source link

Inconsistency of naming convention #58

Open norrec99 opened 3 years ago

norrec99 commented 3 years ago

I think it would be great if we can all agree about the naming convention of those videos so users won't confuse when they see the same videos in different languages.

Here are the some examples from @BigDaddy-Zephyr profile;



Here are the some examples from @hiba-machfej profile;



Here are the some examples from @ozanisgor profile;



How Should It Be?

This is a good example from @amgando profile

amgando commented 3 years ago

Good catch and good idea but how do we enforce this somehow? Maybe change the submission form?

norrec99 commented 3 years ago

For now, we can just fix the name of our videos.

For the newcomers, we can show them what we already have for the naming convention as placeholders or little images while they submit the form. It will be difficult to force them to write video titles as one universal rule but it will decrease the number of bad naming to a minimum.

hiba-machfej commented 3 years ago

True, but also there are some differences that will always be there because we are doing different topics.

For example, when we are referring to a command or to an API, it will always be kebab like near-login or near-api-js even in the docs itself it's referred to in kebab style like here.

However, NEAR Academy is a title related to a tutorial series which makes sense to have in Camel case.

So, I think having differences is good as it can give an overview of what type of video you are seeing. But as you said @norrec99 it would be nice to have a naming convention clear so people will know how to name their work.

norrec99 commented 3 years ago

I see your points and you are right. My point is a little bit different though. We shouldn't care if it is camel case or kebab case but we should care whether the title at the top left corner of the video is exactly the same as the title at the bottom center of the page near the author's profile. Like, if the one says Near Academy - 8 and the other says Near Academy - 9/10. That seems confusing to me even though I know the video content.

Also, we don't need to display the date of the recording in the title like 08 June 2021 - nearkeyshindi, we can say, near keys, near keys(2/3), near-keys, nearKeys(2/3). All of the variants are okay to me.

We can just fix these from the airtable. And I totally agree that having differences is good 👍

hiba-machfej commented 3 years ago

haaaa ok I guess the problem you are talking about is related to both airtable and loom. So, you meant that the loom video is not consistent with airtable.

I see your points and you are right. My point is a little bit different though. We shouldn't care if it is camel case or kebab case but we should care whether the title at the top left corner of the video is exactly the same as the title at the bottom center of the page near the author's profile. Like, if the one says Near Academy - 8 and the other says Near Academy - 9/10. That seems confusing to me even though I know the video content.

Also, we don't need to display the date of the recording in the title like 08 June 2021 - nearkeyshindi, we can say, near keys, near keys(2/3), near-keys, nearKeys(2/3). All of the variants are okay to me.

We can just fix these from the airtable. And I totally agree that having differences is good 👍