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

Remove contributors tag from docs #230

Open
1 task done
ShubhankarKG opened this issue May 22, 2020 · 15 comments
Open
1 task done

Remove contributors tag from docs #230

ShubhankarKG opened this issue May 22, 2020 · 15 comments
Labels
question Further information is requested

Comments

@ShubhankarKG
Copy link
Contributor

I am submitting a -

  • Feature Request
  • [] Bug Report

Describe your feature -

Some pages have mentions while some pages don't. It's better to keep one format.

Current behaviour -

As mentioned above, some pages have mentions while some pages don't

Expected behaviour -

All pages shouldn't have tags like these. Since everybody must have contributed, we can't mention every person on the page. What we can do instead is create a contributions page and show the contribution graph where every contribution is mentioned.

Something like this :

Screenshot from 2020-05-22 11-16-24

Screenshots (if relevant) -

Screenshot from 2020-05-22 11-06-14
Screenshot from 2020-05-22 11-06-17

Are you working on this issue? (Yes/No)

Yes, if approved.

@Shivansh2407
Copy link
Member

I guess it would be better if we can mention each and every contributor who has contributed to the Docs. This will motivate them a lot. For the things wherein the contributors aren't mentioned, we can look out for the commits regarding them and then mention the contributor name/ID.
Let me know your views.

@YashKumarVerma
Copy link
Member

YashKumarVerma commented May 22, 2020

I think seeing the number of contributions, (even a type fix = contribution), we cannot have every name on the documentation, as it will fill up the docs with user handles.

But, instead something like this can be added to readme, or as mentioned in PR body, as is done for the interactive book can be done.
image

This solution is

  • dynamic
  • does not crowd the documentation
  • no manual work needed (addition)

@Shivansh2407
Copy link
Member

Yeah this can be implemented @YashKumarVerma . But what I was talking about was regarding Contributing new material like adding flip flop conversions which is a new section. So for that we can mention the name of the contributor, while for a typo fix, rephrasing content we can have the contributor section as you suggested.

@ShubhankarKG
Copy link
Contributor Author

As far as contributing section is concerned, all contributions are covered in the contribution graph itself. Mentioning specific people might look enticing, but can also be detrimental in the sense, that for a page that had 4 or 5 contributors, only 1 had a mention.

@YashKumarVerma
Copy link
Member

Yeah this can be implemented @YashKumarVerma . But what I was talking about was regarding Contributing new material like adding flip flop conversions which is a new section. So for that we can mention the name of the contributor, while for a typo fix, rephrasing content we can have the contributor section as you suggested.

I don't think we should do something like that, because, at some point in future, there would a doubt regarding our definition of "new material". It can be adding a new example as well, or adding a new para of explanation about some topic, and then we'd arrive at conflicts again.

@YashKumarVerma YashKumarVerma pinned this issue May 22, 2020
@Shivansh2407
Copy link
Member

Ok cool. @ShubhankarKG then you can go ahead and fix this by removing all the contributors from docs and adding a contributors Section 👍

@YashKumarVerma
Copy link
Member

Ok cool. @ShubhankarKG then you can go ahead and fix this by removing all the contributors from docs and adding a contributors Section

or should we wait for opinions of other contributions till evening (IST)?

@ShubhankarKG
Copy link
Contributor Author

I'll keep the PR ready just in case no one responds. Let's wait till 4 p.m.

@Shivansh2407
Copy link
Member

Ok cool. @ShubhankarKG then you can go ahead and fix this by removing all the contributors from docs and adding a contributors Section

or should we wait for opinions of other contributions till evening (IST)?

Sure 👍. @satu0king @tachyons @nitin10s please let us know your views.

@ShubhankarKG
Copy link
Contributor Author

Should we wait @YashKumarVerma , @Shivansh2407 ?

@YashKumarVerma
Copy link
Member

Should we wait @YashKumarVerma , @Shivansh2407 ?

Send the PR, just in case there'd be a problem, we can revert it as well.

@ShubhankarKG
Copy link
Contributor Author

Done

@nitin10s
Copy link
Member

Looks like a nice idea to me @satu0king. The PR needs some changes though.

@YashKumarVerma YashKumarVerma added the question Further information is requested label May 25, 2020
@YashKumarVerma
Copy link
Member

@nitin10s could you help us out in getting this done ?

@ShubhankarKG
Copy link
Contributor Author

#233 has been approved by him I guess. Requesting @tachyons @satu0king to have a look

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants