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

Feature: Add glossary to getting started section #200

Closed
2 tasks done
BekahHW opened this issue Nov 1, 2023 · 10 comments
Closed
2 tasks done

Feature: Add glossary to getting started section #200

BekahHW opened this issue Nov 1, 2023 · 10 comments
Assignees
Labels
💡 feature A label to note if work is a feature released

Comments

@BekahHW
Copy link
Member

BekahHW commented Nov 1, 2023

Type of feature

🍕 Feature

Current behavior

There's not currently a glossary of terms. Although tooltips are being implemented on the app side, we can implement it here as well

Suggested solution

Rather than having a separate file for each term, we could have a glossary in the getting started section.

  1. Create glossary.md in the getting started section.
  2. The title should be "OpenSauced Glossary"
  3. Description: Welcome to the glossary, where we define concepts used on our platform to help you get the most out of OpenSauced.
  4. Add the page to sidebar.js

Terms to include

  • PR Velocity
  • Activity
  • PR Overview
  • Alumni Contributors
  • Active Contributors
  • New Contributors
  • Churned Contributors
  • Insights
  • Lists

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs
@BekahHW BekahHW added 💡 feature A label to note if work is a feature 👀 needs triage 🛑 blocked blocked by another issue. labels Nov 1, 2023
@Lymah123
Copy link
Contributor

Lymah123 commented Nov 1, 2023

Hi @BekahHW , Can I work on the issue?

@BekahHW
Copy link
Member Author

BekahHW commented Nov 2, 2023

@Lymah123 it's on hold until the new organization PR is merged in.

@Lymah123
Copy link
Contributor

Lymah123 commented Nov 2, 2023

@Lymah123 it's on hold until the new organization PR is merged.

Okay. Thanks.

@BekahHW BekahHW removed 👀 needs triage 🛑 blocked blocked by another issue. labels Nov 9, 2023
@BekahHW
Copy link
Member Author

BekahHW commented Nov 9, 2023

@Lymah123 are you still interested in working on this?

I've added some of the definitions in the comments of this PR: open-sauced/app#1806 (comment)

@Lymah123
Copy link
Contributor

@Lymah123 are you still interested in working on this?

I've added some of the definitions in the comments of this PR: open-sauced/app#1806 (comment)

Hi @BekahHW , yes I'm still interested.

@Lymah123
Copy link
Contributor

Hi @BekahHW , I can't find getting started section in the docs repo, but there is getting started section in intro repo.

Or should I put it under introduction.md section?

You suggested the glossary. md should be inside the getting started section.

@Lymah123
Copy link
Contributor

Hi @BekahHW , I can't find getting started section in the docs repo, but there is getting started section in intro repo.

Or should I put it under introduction.md section?

You suggested the glossary. md should be inside the getting started section.

Hi @CBID2 , can you check the question please

@BekahHW
Copy link
Member Author

BekahHW commented Nov 16, 2023

In the repo, it's the community folder.

@BekahHW
Copy link
Member Author

BekahHW commented Nov 16, 2023

Sorry about that. We'll be renaming and changing up some of this stuff soon.

On the site, community shows up as Getting Started.

Copy link
Contributor

🎉 This issue has been resolved in version 1.53.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 feature A label to note if work is a feature released
Projects
None yet
Development

No branches or pull requests

3 participants