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

Docs: Add badges to docusauras Home.md #201

Open
Amulya-coder opened this issue Mar 24, 2021 · 21 comments · May be fixed by #278
Open

Docs: Add badges to docusauras Home.md #201

Amulya-coder opened this issue Mar 24, 2021 · 21 comments · May be fixed by #278
Assignees
Labels
Category: Documentation/Training Improvements or additions to documentation. First Timers Only Good for newcomers.

Comments

@Amulya-coder
Copy link
Member

Amulya-coder commented Mar 24, 2021

Is your feature request related to a problem? Please describe.

Add badges to the docusauras home.md

Describe the solution you'd like

image

Additional context

None

@welcome
Copy link

welcome bot commented Mar 24, 2021

Hello there!👋 Welcome to the project!💖

Thank you and congrats🎉for opening your very first issue in this project. AnitaB.org is an inclusive community, committed to creating a safe and positive environment.🌸 Please adhere to our Code of Conduct.🙌 You may submit a PR if you like! If you want to report a bug🐞 please follow our Issue Template. Also make sure you include steps to reproduce it and be patient while we get back to you.😄

Feel free to join us on AnitaB.org Open Source Zulip Community.💖 We have different streams for each active repository for discussions.✨ Hope you have a great time there!😄

@Amulya-coder Amulya-coder added Category: Documentation/Training Improvements or additions to documentation. First Timers Only Good for newcomers. Open Source Hack Status: Available Issue was approved and available to claim or abandoned for over 3 days. labels Mar 24, 2021
@Rahulm2310
Copy link
Contributor

@Amulya-coder Please remove the fork and star label from the screenshot as there is no need for them. Also, there is a zulip label already. Please remove that as well.

@mtreacy002
Copy link
Member

I don't think we need "Maintained" and "PRs" tags either, @Amulya-coder. Plus, the License already shown on Github UI, so please remove that as it is redundant.

Saying that, I don't mind seeing all the GitHub UI tags + README tags being included in the docusaurus Home.md since we won't be able to see the GitHub UI tags there.
PS: @Rahulm2310 , while we're on the docusaurus topic, is it possible to use .md parser from the wiki .md files, that way we'll avoid the risk of having 2 different contents (wiki vs docusaurus). If we can use the .md parser in Home.md on docusaurus under the tags, that'll be best.

What do you all think?

@Rahulm2310
Copy link
Contributor

If we can use the .md parser in Home.md on docusaurus under the tags, that'll be best.

@mtreacy002 Unable to get your point. Can you be more clear

@mtreacy002 mtreacy002 added Status: On Hold Issue or PR needs more info, a discussion, a review or approval from a Maintainer/Code Owner. and removed Status: Available Issue was approved and available to claim or abandoned for over 3 days. labels Mar 26, 2021
@mtreacy002
Copy link
Member

mtreacy002 commented Mar 26, 2021

@Rahulm2310, at the moment we have a copy of Home.md in the docusaurus docs folder (along with other .md files as well).
Screen Shot 2021-03-27 at 8 50 51 am

The issue with this, if the content in wiki page is modified, the changes will not be automatically detected in the docusaurus .md version which means we'll have conflicting information. If we can use the .md parser on our docusaurus, then the changes made to wiki will automatically applied to docusaurus. So, that's the first point I have in mind.

The second point is on the redundant tags that we don't want to have on README.md files since they are visible on Github UI. IMO, these tags are redundant on the README.md file for the repo, but they are important information that currently missing on the docusaurus Home.md. So, my suggestion is to add the tags in the docusaurus Home.md.

I hope this helps explain my intention better 😉

@naveen8801
Copy link
Contributor

Hi @mtreacy002 @Rahulm2310 @Amulya-coder I'd like to work on it , can you assign it to me .?

@Amulya-coder
Copy link
Member Author

Amulya-coder commented Apr 4, 2021

@naveen8801 thanks for showing interest in this issue, firstly I give you the idea about this issue -> you have to add the badges on the docusauras Home.md so that it's visible on the docusauras documentation not on readme as explained by the mtreachy above ☝ would you know how to do that? if yes I will assign it to you.

@naveen8801
Copy link
Contributor

@Amulya-coder , i think you are talking about this https://github.com/anitab-org/bridge-in-tech-backend/tree/develop/docs/docs , and here Home.md should contain these badges or something else ?

@Amulya-coder
Copy link
Member Author

Yes @naveen8801 would you like to work on this

@naveen8801
Copy link
Contributor

naveen8801 commented Apr 4, 2021

Ya i'd like to work on it , but this means that i have to submit PR for ' bridge-in-tech-backend ' repo , right ?

@Amulya-coder
Copy link
Member Author

Amulya-coder commented Apr 4, 2021

Yes @Naveen880, commented on that issue I will assign it to you.

@naveen8801
Copy link
Contributor

Sure , i wanna work on this @Amulya-coder , 👍

@Rahulm2310
Copy link
Contributor

@Amulya-coder I think this should be put on hold as we don't have the docusaurus website for frontend yet. Also, please update the issue description with what needs to be done.

@Amulya-coder Amulya-coder changed the title Docs: Add more badges to readme Docs: Add badges to docusauras Home.md Apr 4, 2021
@mtreacy002 mtreacy002 added Status: Available Issue was approved and available to claim or abandoned for over 3 days. and removed Status: On Hold Issue or PR needs more info, a discussion, a review or approval from a Maintainer/Code Owner. labels Jun 25, 2021
@mtreacy002
Copy link
Member

Making the issue available since now we have BIT frontend docusaurus

@IC1101Virgo
Copy link

Hello, can I work on this?

@Rahulm2310
Copy link
Contributor

Sure @IC1101Virgo. Assigning you ☺️

@Rahulm2310 Rahulm2310 removed the Status: Available Issue was approved and available to claim or abandoned for over 3 days. label Jun 27, 2021
@IC1101Virgo
Copy link

I have a doubt regarding the task what needs to be done?
I can see the badges here https://github.com/anitab-org/bridge-in-tech-backend/blob/develop/docs/docs/Home.md
Do I need to add any more? Or need to add them somewhere else?

Thank you in advance

@Rahulm2310
Copy link
Contributor

@IC1101Virgo you need to add the badges here on this repo i.e. bridge-in-tech-web. The link you are using is for the backend repo.

@harsh7in
Copy link

@Rahulm2310, I want to contribute to the project, can i work on this issue?

@isabelcosta
Copy link
Member

@harsh-9in will assign to you since there are no updates for a while from @IC1101Virgo

@IC1101Virgo if I got this wrong and you are still interested in contributing, let us know :)

@isabelcosta isabelcosta assigned harsh7in and unassigned IC1101Virgo Oct 17, 2021
@harsh7in harsh7in linked a pull request Oct 18, 2021 that will close this issue
11 tasks
@Esther-Wavinya
Copy link

Hello. Is this issue still open? @isabelcosta @Amulya-coder . If yes. Can I work on it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation/Training Improvements or additions to documentation. First Timers Only Good for newcomers.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants