feat: Add information on the graphs in the List page #258

Lymah123 · 2024-02-23T17:45:46Z

Description

This PR adds the feature.

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

Related Tickets & Documents

Please use this format link issue numbers: Fixes #236

Mobile & Desktop Screenshots/Recordings

Steps to QA

Added to documentation?

[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 · 2024-02-23T17:45:49Z

👷 Deploy request for docs-open pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`f1bc7d8`

Lymah123 · 2024-02-23T17:48:05Z

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

docs/features/lists.md

Lymah123 · 2024-02-24T08:33:49Z

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

docs/features/lists.md

Lymah123 · 2024-02-25T18:29:13Z

Hi, @BekahHW! You can check.

adiati98 · 2024-03-01T09:41:27Z

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

Thank you! 😊

Lymah123 · 2024-03-01T14:30:25Z

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 · 2024-03-01T14:38:49Z

@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 · 2024-03-01T16:35:58Z

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 · 2024-03-01T17:00:45Z

@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.

…page-updates

adiati98 · 2024-03-01T20:19:33Z

@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 · 2024-03-01T20:32:28Z

@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 · 2024-03-01T20:34:53Z

@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 · 2024-03-01T20:50:29Z

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 · 2024-03-01T20:55:47Z

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 · 2024-03-02T17:07:49Z

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 · 2024-03-02T17:38:29Z

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

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

adiati98 · 2024-03-02T19:46:08Z

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 · 2024-03-12T16:24:32Z

Hi, @BekahHW and @adiati98 .

Any updates on the PR?

BekahHW · 2024-03-12T16:32:03Z

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 <#258 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AIFZJRLI3HS3MYMIGJ5DDSTYX4T5NAVCNFSM6AAAAABDXDKLTOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOJSGA3DINRYGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

BekahHW

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.

Lymah123 · 2024-03-14T11:17:51Z

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!

…t-page-updates

Lymah123 · 2024-04-02T10:42:17Z

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

BekahHW

@Lymah123 go back to the original issue. Here are the tips again. Pay particular attention to the bolded ones. You should be writing general documentation and adding the correct images.

Tips

Use the list feature so you have an understanding of what you're looking at.
If you have questions about the feature, leave them in the comments of this issue
Adding docs to this section should be targeted at a general audience. That means you can't take the information from the guide word for word. Think about maintainers, contributors, and organizations.
Use the images in the guide, rather than creating new ones.

docs/features/lists.md

Lymah123 · 2024-04-02T15:29:25Z

@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.

BekahHW · 2024-04-03T12:50:38Z

docs/features/contributor-insights.md


 1. **Explore Contributors**: Use our explore tool to find contributors and create your list.
 2. **Sync your GitHub Team**: Connect to your GitHub to create a Contributor Insight Page from a team in your organization.
 3. **Import your GitHub Following**: Connect to your GitHub to create a Contributor Insight Page with all the contributors you follow.

 Once your Contributor Insight Page is created, you'll be able to see an overview of all the contributors in your list, a graph of their activity, and a detailed breakdown of the contributors.

-:::tip


Why are you removing the tip here?

Why are you removing the tip here?

I did not see a tip in the modified file. I saw the tip while I was trying to fix the merge conflict. A reason I removed it.

Ah, I like the tip because it makes it stand out.

BekahHW · 2024-04-03T12:53:14Z

docs/features/contributor-insights.md

+- **Potential hires**: Observe contributors who exhibit skill and commitment, making them prime candidates for hiring.
+
+- **Alumni contributors**: Keep an eye on contributors who have decreased their engagement or left the project.
+

 After logging in, navigate to "Insights" in the sidebar. Click the "+" next to it to be presented with options, and select "New Contributor Insight."


This line shouldn't be in between these lists.

BekahHW · 2024-04-03T12:53:50Z

docs/features/contributor-insights.md

+
+- **Track contributors for job opportunities**: If you're looking for a job, you can track the activity of the contributors you're interested in working with. This helps you understand the activity level of the repositories and the types of contributions being made, and you can even identify which company you want to contribute to.
+
+There are Three ways to add contributors to track:


This repeats information that you have below. Delete it here and keep the section below.

BekahHW · 2024-04-03T12:54:08Z

docs/features/contributor-insights.md

+
+## How to Create a Contributor Insight Page
+
+After logging in, navigate to your OpenSauced workspace. Click on the navigation bar of your workspace home page. Click on the plus sign beside insight. Two options will display, which are ; New repository insight and New contributor insight. Click on the New contributor insight. Then add the contributors by searching for their names or import contributors by syncing your GitHub following.


Use a bulleted list for directions

…t-page-updates

Lymah123 · 2024-04-03T18:47:15Z

@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 · 2024-04-14T16:31:24Z

Hi @BekahHW, you can check again.

BekahHW · 2024-04-16T21:57:13Z

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 · 2024-04-20T17:19:13Z

@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 · 2024-04-20T23:45:02Z

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 · 2024-04-20T23:45:58Z

@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 · 2024-04-24T15:18:06Z

@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 · 2024-04-25T12:18:50Z

@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!

Add information on the graphs in the List feature

136ea4f

BekahHW requested changes Feb 23, 2024

View reviewed changes

docs/features/lists.md Outdated Show resolved Hide resolved

docs/features/lists.md Outdated Show resolved Hide resolved

docs/features/lists.md Outdated Show resolved Hide resolved

Changes made

fc26c69

BekahHW requested changes Feb 24, 2024

View reviewed changes

docs/features/lists.md Outdated Show resolved Hide resolved

docs/features/lists.md Outdated Show resolved Hide resolved

docs/features/lists.md Outdated Show resolved Hide resolved

Adds update

433467e

resolce conflict

bef5f3c

Lymah123 added 2 commits March 1, 2024 17:12

Resolve conflict by removing lists.md

d143e87

Adds lists-page

b29e9cf

Lymah123 requested a review from a team as a code owner March 1, 2024 16:31

Merge branch 'main' of https://github.com/open-sauced/docs into list-…

d842a19

…page-updates

BekahHW requested changes Mar 13, 2024

View reviewed changes

Lymah123 closed this Mar 30, 2024

Lymah123 deleted the list-page-updates branch March 30, 2024 14:40

Lymah123 restored the list-page-updates branch March 30, 2024 14:44

Lymah123 reopened this Mar 30, 2024

Lymah123 added 3 commits April 2, 2024 11:25

Adds contributor insights

30a994e

Merge branch 'list-page-updates' of github.com:Lymah123/docs into lis…

2df8b4e

…t-page-updates

Merge branch 'main' into list-page-updates

8938cfd

BekahHW requested changes Apr 2, 2024

View reviewed changes

docs/features/lists.md Outdated Show resolved Hide resolved

Delete docs/features/lists.md

5e745f4

Update contributor-insights.md

ada6803

BekahHW reviewed Apr 3, 2024

View reviewed changes

Lymah123 added 2 commits April 3, 2024 19:20

adds contributor insights

f7d387b

Merge branch 'list-page-updates' of github.com:Lymah123/docs into lis…

3348397

…t-page-updates

adds changes

f1bc7d8


		- Track contributors for job opportunities: If you're looking for a job, you can track the activity of the contributors you're interested in working with. This helps you understand the activity level of the repositories and the types of contributions being made, and you can even identify which company you want to contribute to.

		There are Three ways to add contributors to track:


		## How to Create a Contributor Insight Page

		After logging in, navigate to your OpenSauced workspace. Click on the navigation bar of your workspace home page. Click on the plus sign beside insight. Two options will display, which are ; New repository insight and New contributor insight. Click on the New contributor insight. Then add the contributors by searching for their names or import contributors by syncing your GitHub following.

feat: Add information on the graphs in the List page #258

Are you sure you want to change the base?

feat: Add information on the graphs in the List page #258

Conversation

Lymah123 commented Feb 23, 2024

Description

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

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Steps to QA

Added to documentation?

[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 commented Feb 23, 2024 • edited

👷 Deploy request for docs-open pending review.

Lymah123 commented Feb 23, 2024

Lymah123 commented Feb 24, 2024 • edited

Lymah123 commented Feb 25, 2024

adiati98 commented Mar 1, 2024

Lymah123 commented Mar 1, 2024

adiati98 commented Mar 1, 2024 • edited

Lymah123 commented Mar 1, 2024 • edited

adiati98 commented Mar 1, 2024

adiati98 commented Mar 1, 2024 • edited

Lymah123 commented Mar 1, 2024 • edited

Lymah123 commented Mar 1, 2024

adiati98 commented Mar 1, 2024

Lymah123 commented Mar 1, 2024

BekahHW commented Mar 2, 2024

Lymah123 commented Mar 2, 2024 • edited

adiati98 commented Mar 2, 2024

Lymah123 commented Mar 12, 2024

BekahHW commented Mar 12, 2024 via email

BekahHW left a comment

Choose a reason for hiding this comment

Lymah123 commented Mar 14, 2024

Lymah123 commented Apr 2, 2024

BekahHW left a comment

Choose a reason for hiding this comment

Tips

Lymah123 commented Apr 2, 2024 • edited

BekahHW Apr 3, 2024

Choose a reason for hiding this comment

Lymah123 Apr 3, 2024

Choose a reason for hiding this comment

BekahHW Apr 11, 2024

Choose a reason for hiding this comment

BekahHW Apr 3, 2024

Choose a reason for hiding this comment

BekahHW Apr 3, 2024

Choose a reason for hiding this comment

BekahHW Apr 3, 2024

Choose a reason for hiding this comment

Lymah123 commented Apr 3, 2024 • edited

Lymah123 commented Apr 14, 2024

BekahHW commented Apr 16, 2024

BekahHW commented Apr 20, 2024

Lymah123 commented Apr 20, 2024

Lymah123 commented Apr 20, 2024

BekahHW commented Apr 24, 2024

Lymah123 commented Apr 25, 2024

netlify bot commented Feb 23, 2024 •

edited

Lymah123 commented Feb 24, 2024 •

edited

adiati98 commented Mar 1, 2024 •

edited

Lymah123 commented Mar 1, 2024 •

edited

adiati98 commented Mar 1, 2024 •

edited

Lymah123 commented Mar 1, 2024 •

edited

Lymah123 commented Mar 2, 2024 •

edited

Lymah123 commented Apr 2, 2024 •

edited

Lymah123 commented Apr 3, 2024 •

edited