feat: Add information on the graphs in the List page

[Lymah123]

Description

This PR adds the feature.

What type of PR is this? (check all applicable)

• [x] 🍕 Feature
• [ ] 🐛 Bug Fix
• [x] 📝 Documentation Update
• [ ] 🎨 Style
• [ ] 🧑‍💻 Code Refactor
• [ ] 🔥 Performance Improvements
• [ ] ✅ Test
• [ ] 🤖 Build
• [ ] 🔁 CI
• [ ] 📦 Chore (Release)
• [ ] ⏩ Revert

Related Tickets & Documents

Please use this format link issue numbers: Fixes #236

Mobile & Desktop Screenshots/Recordings

Steps to QA

Added to documentation?

• [ ] 📜 README.md
• [x] 📓 docs.opensauced.pizza
• [ ] 🍕 dev.to/opensauced
• [ ] 📕 storybook
• [ ] 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

[netlify[bot]]

👷 Deploy request for docs-open pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	f1bc7d8879242d91e62eef36520f31bf5b01cf43

[Lymah123]

Hi, @BekahHW. Looking forward to the feedback.Thank you!

[Lymah123]

Hi @BekahHW, I made changes based on the suggestions. You can now check.

[Lymah123]

Hi, @BekahHW! You can check.

[adiati98]

Hi @Lymah123, We've merged some a PR before yours. Can you please resolve the merge conflicts here?

Thank you! 😊

[Lymah123]

Hi @adiati98 . Check the screenshot for the message on the conflicts.

My branch is up to date.

Should I create a new PR?

Thank you!

[adiati98]

@Lymah123 if you see the message at the end, it says that this branch has conflicts that must be resolved, and in which file.

You don't need to create a new PR. You just need to pull the main branch of the upstream repo to your working branch to update it and resolve the conflicts on your text editor. Chcekout this blog post to resolve conflicts.

Please let me know if you have any question or help. Thanks!

[Lymah123]

Hi @adiati98 , thank you. I read your article on it before I even sent the previous message. I was stuck still. But guess what, I have been able to fix it. Thank you for mentioning that I should start with upstream. I should blog on how I fixed it.

You can now check. Thank you so much!

[adiati98]

@Lymah123, good to hear that you've succeeded! I'll check it once I get back to my laptop 😊

---

If you already have upstream added as your remote repo, you can always pull the main branch directly from the upstream.

This article is walking through beginners in updating their forked (origin) repo with the latest state of upstream before resolving conflicts because the good practice is to fork the upstream repo, clone the forked (origin) repo, and work on changes on this repo.

Adding steps to add upstream as remote repo and pull changes from upstream in the article will potentially confusinf and give them trouble when they accidentally work on themain branch.

Also, some repos don't allow changes/branches to be pushed directly to the upstream. For beginners, this will be too confusing and discouraging when they have to troubleshoot.

[adiati98]

@BekahHW I only noticed merge conflicts before and just see this PR closely.

The "List" is now changed to "Contributor Insights". Do we still need this?

[Lymah123]

@Lymah123, good to hear that you've succeeded! I'll check it once I get back to my laptop 😊

If you already have upstream added as your remote repo, you can always pull the main branch directly from the upstream.

This article is walking through beginners in updating their forked (origin) repo with the latest state of upstream before resolving conflicts because the good practice is to fork the upstream repo, clone the forked (origin) repo, and work on changes on this repo.

Adding steps to add upstream as remote repo and pull changes from upstream in the article will potentially confusinf and give them trouble when they accidentally work on themain branch.

Also, some repos don't allow changes/branches to be pushed directly to the upstream. For beginners, this will be too confusing and discouraging when they have to troubleshoot.

Okay, thanks alot @adiati98 !

If I would be creating blog post on something like that, the article should simplifies the process for beginners and encourages a workflow that aligns with best practices in collaborative development.

[Lymah123]

@BekahHW I only noticed merge conflicts before and just see this PR closely.

The "List" is now changed to "Contributor Insights". Do we still need this?

Hi @adiati98 , you mean there's no more lists section, it has changed to contribution insights?

[adiati98]

Hi @adiati98 , you mean there's no more lists section, it has changed to contribution insights?

We just launched a new feature 3 days ago that included name changing. Bekah has a day off. So, let's hear from her once she's back next week. 😊

[Lymah123]

Hi @adiati98 , you mean there's no more lists section, it has changed to contribution insights?

We just launched a new feature 3 days ago that included name changing. Bekah has a day off. So, let's hear from her once she's back next week. 😊

Alright! Thanks for the prompt responses, @adiati98 ❤ !

[BekahHW]

Here's the new information. It's still the same feature, it just has a new name. https://github.com/open-sauced/docs/blob/main/docs/features/contributor-insights.md

[Lymah123]

Quick question: I should change the lists in the file to contributors insights right?

@BekahHW and @adiati98 ! Happy new month to you both.

[adiati98]

Quick question: I should change the lists in the file to contributors insights right?

We might do that. But let's hold this a bit longer and wait for @BekahHW. She will get back to you once she's back from her day off. 😊

[Lymah123]

Hi, @BekahHW and @adiati98 .

Any updates on the PR?

[BekahHW]

Now that we shipped the updates with workspaces today, I'll be able to get back to this tomorrow.

On Tue, Mar 12, 2024 at 12:24 PM Lymah123 @.***> wrote:

Hi, @BekahHW https://github.com/BekahHW and @adiati98 https://github.com/adiati98 .

Any updates on the PR?

— Reply to this email directly, view it on GitHub https://github.com/open-sauced/docs/pull/258#issuecomment-1992064686, or unsubscribe https://github.com/notifications/unsubscribe-auth/AIFZJRLI3HS3MYMIGJ5DDSTYX4T5NAVCNFSM6AAAAABDXDKLTOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOJSGA3DINRYGY . You are receiving this because you were mentioned.Message ID: @.***>

[Lymah123]

Since we renamed things (lists are now contributor insights), you'll need to work in the new file.

Here's the link to the docs currently: https://docs.opensauced.pizza/features/contributor-insights/

The file is contributor-insights.md.

Because we've added workspaces, take a bit of time to use them to create a contributor insight so you understand the flow.

When you link to an asset, it shouldn't be linked to the docs, it should be linked to the file in the repo. For example, you have this ![Here](https://docs.opensauced.pizza/assets/images/team-sync-09e7e2ab7b54fae335f5b4c40cce94b1.gif) but it should be this: ![Team Sync gif](../../static/gif/team-sync.gif)

We don't need to have the section on the highlights feature. If you think it's important to include, just link to the highlights feature file.

Just take a look at this section in the maintainers guide. Stop once you hit the highlights section.

Hi @BekahHW , I got that. I will let you know if I have any questions. Thank you!

[Lymah123]

Hi @BekahHW , and @adiati98. I will be awaiting your feedback.

[Lymah123]

@BekahHW, I just removed the lists.md file from this PR. Let me know what other things to work on. Also, I only made changes to the previous submission before the release of the new feature.

[Lymah123]

@BekahHW , I just made changes based on your observation on my local machine. I will be waiting for the response to the questions I left before submitting the update I made.

[Lymah123]

Hi @BekahHW, you can check again.

[BekahHW]

Hey @Lymah123, we're at our team onsite and a conference this week. I'll try to get to it, but may not until next week.

[BekahHW]

@Lymah123, these are the headings you should have after the image:

## Why Create a Contributor Insight Page?
## How to Create a Contributor Insight Page 
## Using Your Contributor Insight Page

You can use the maintainer guide and the Contributor Guide to help you generate the content.

We want a condensed version on this page, so summarize what those guides say for a general audience but link to those sections.

[Lymah123]

Hey @Lymah123, we're at our team onsite and a conference this week. I'll try to get to it, but may not until next week.

Have fun there @BekahHW.

[Lymah123]

@Lymah123, these are the headings you should have after the image:

## Why Create a Contributor Insight Page?
## How to Create a Contributor Insight Page 
## Using Your Contributor Insight Page

You can use the maintainer guide and the Contributor Guide to help you generate the content.

We want a condensed version on this page, so summarize what those guides say for a general audience but link to those sections.

Alright. I will work on the feedback. Thank you!

[BekahHW]

@Lymah123 just a heads-up we just merged in a pretty big update to the docs, so you'll want to pull from main and install the new dependencies.

[Lymah123]

@Lymah123 just a heads-up we just merged in a pretty big update to the docs, so you'll want to pull from main and install the new dependencies.

Noted @BekahHW. Thank you!