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

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

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

Lymah123
Copy link
Contributor

Description

This PR adds the feature.

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

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ 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
  • πŸ““ 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?

Copy link

netlify bot commented Feb 23, 2024

πŸ‘· Deploy request for docs-open pending review.

Visit the deploys page to approve it

Name Link
πŸ”¨ Latest commit f1bc7d8

@Lymah123
Copy link
Contributor Author

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

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
@Lymah123
Copy link
Contributor Author

Lymah123 commented Feb 24, 2024

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

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
@Lymah123
Copy link
Contributor Author

Hi, @BekahHW! You can check.

@adiati98
Copy link
Member

adiati98 commented Mar 1, 2024

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

Thank you! 😊

@Lymah123
Copy link
Contributor Author

Lymah123 commented Mar 1, 2024

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!

image

@adiati98
Copy link
Member

adiati98 commented Mar 1, 2024

@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 Lymah123 requested a review from a team as a code owner March 1, 2024 16:31
@Lymah123
Copy link
Contributor Author

Lymah123 commented Mar 1, 2024

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
Copy link
Member

adiati98 commented Mar 1, 2024

@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
Copy link
Member

adiati98 commented Mar 1, 2024

@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
Copy link
Contributor Author

Lymah123 commented Mar 1, 2024

@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
Copy link
Contributor Author

Lymah123 commented Mar 1, 2024

@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
Copy link
Member

adiati98 commented Mar 1, 2024

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
Copy link
Contributor Author

Lymah123 commented Mar 1, 2024

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
Copy link
Member

BekahHW commented Mar 2, 2024

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
Copy link
Contributor Author

Lymah123 commented Mar 2, 2024

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

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

@adiati98
Copy link
Member

adiati98 commented Mar 2, 2024

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
Copy link
Contributor Author

Hi, @BekahHW and @adiati98 .

Any updates on the PR?

@BekahHW
Copy link
Member

BekahHW commented Mar 12, 2024 via email

Copy link
Member

@BekahHW BekahHW left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor Author

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 Lymah123 closed this Mar 30, 2024
@Lymah123 Lymah123 deleted the list-page-updates branch March 30, 2024 14:40
@Lymah123 Lymah123 restored the list-page-updates branch March 30, 2024 14:44
@Lymah123 Lymah123 reopened this Mar 30, 2024
@Lymah123
Copy link
Contributor Author

Lymah123 commented Apr 2, 2024

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

Copy link
Member

@BekahHW BekahHW left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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 Outdated Show resolved Hide resolved
@Lymah123
Copy link
Contributor Author

Lymah123 commented Apr 2, 2024

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


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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you removing the tip here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

- **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."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line shouldn't be in between these lists.


- **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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


## 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use a bulleted list for directions

@Lymah123
Copy link
Contributor Author

Lymah123 commented Apr 3, 2024

@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
Copy link
Contributor Author

Hi @BekahHW, you can check again.

@BekahHW
Copy link
Member

BekahHW commented Apr 16, 2024

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
Copy link
Member

BekahHW commented Apr 20, 2024

@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
Copy link
Contributor Author

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
Copy link
Contributor Author

@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
Copy link
Member

BekahHW commented Apr 24, 2024

@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
Copy link
Contributor Author

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

@CBID2
Copy link
Contributor

CBID2 commented May 27, 2024

Hey @Lymah123.You still working on this?

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

Successfully merging this pull request may close these issues.

feat: Add information on the graphs in the List feature
4 participants