fix: format and wording adjustments in workspaces, contributors and repo insights sections #262

adiati98 · 2024-02-28T16:54:22Z

Description

This PR fixes format and adjusts wording in workspaces, contributors and the repo insights sections, as well as sections that need to be updated with this new feature.

This changes are related to PR #255

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 · 2024-02-28T16:54:42Z

✅ Deploy Preview for docs-open ready!

Name	Link
🔨 Latest commit	`e338c8f`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-open/deploys/65e7364429572200080f2a97
😎 Deploy Preview	https://deploy-preview-262--docs-open.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sidebars.js

adiati98

Hi @BekahHW

This PR is ready for review, and I'm leaving here some comments and questions.

Thank you! 😊

docs/features/workspaces.md

docs/features/contributor-insights.md

docs/features/repo-insights.md

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

docs/features/workspaces.md

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

BekahHW

This is great. Thanks, Ayu. I left some comments.

…into fix/workspaces

adiati98 · 2024-02-28T19:48:46Z

@BekahHW I've changed the wording as per your request. Ready for final review!

adiati98

Hey @BekahHW

I left some comments to get your thoughts here.
I'll reread everything one more time tomorrow.

Thank you! 😄

adiati98 · 2024-03-03T22:00:40Z

docs/contributors/contributors-guide.md

+#### Activity
+
+The "Activity" tab shows a graph of the last time each contributor created their PR and how many lines of code they've touched.
+
+It also provides more detailed information on each contributor when you hover over their image, including their latest PRs and repositories they've contributed to. Clicking their image will bring you to their profile on OpenSauced. This information can help you find potential repositories to contribute to and peers to collaborate with or ask for mentorship.
+
+![activity graph](../../static/img/activity-repos-insights.png)


I added the Activity tab subsection, as well as an image for the tab.
I'm not sure if you're intentionally leaving it out. So please let me know if I need to remove it.

I also added the same subsection for the Maintainers Guide. Wordings are the same. The difference is the purpose of this tab for contributor and maintainer, which I need you to check if this is a go.

Thanks! 😊

I'm not sure how that got left out. Thanks for adding it in.

docs/features/workspaces.md

docs/maintainers/understanding-repo-insights.md

docs/maintainers/maintainers-guide.md

…orkspaces

…nsights Page of contributors-guide.md

adiati98 · 2024-03-04T12:41:33Z

docs/features/workspaces.md


 :::

 ### How to Add Repositories to a Workspace

 If you're creating a new workspace, you'll have the option to add repositories at the time of creation.

-Start by creating a Workspace name, and then click `Add repositories`. You'll have three options for adding repositories:
+Start by creating a workspace name, then click "Add repositories." You'll have three options for adding repositories:


I'm trying this out again. I think start by creating a workspace name can be confusing and can be a bit misleading here.

So, there are 2 ways to add repositories to a workspace:

Start by clicking the "Add repositories" button. Then, choose an option to add repostories: Search for repositories, Import a GH org, or Import repositories. Afterwards, add the name of the workspace (this is required), and add description (optional).

Start by clicking the "Edit" button. Then, add name of the workspace, the repositories, and update/save the workspace.

We can either include both ways, or include the first one, that make more sense to create a workspce for the first time. But either way, we want to inform that adding the workspace name is required.
We can do it in this PR, or create a new issue for this.

I think there are two issues here: Maybe the issue here is "How to Add repositories to a workspace" and "How to Add Repos to Your Personal Workspace."

We can have two separate lines.

Adding repos to a workspace- {description}

Adding repos to your personal workspace - {Deseciption}

I believe that only the personal workspace has the edit button. That's because it also takes you to the settings page where you can add workspace members, change the visibility, and upgrade. Which is something I'm going to add to the docs after we get this merged in.

Ah, now I see. You're right. Only "Your personal workspace" that has the edit button in the beginning.
Creating new workspace will take us the creation form as below. But once it's created, it also has an edit button.

I remember that you will add more details to the workspaces, but I'm not sure if this one of them. So, I throw this here, just in case. 😅

I think this could be a separate issue. What do you think @BekahHW?

docs/maintainers/understanding-repo-insights.md

docs/contributors/contributors-guide.md

docs/maintainers/maintainers-guide.md

adiati98 · 2024-03-04T19:00:37Z

docs/contributors/contributors-guide.md

 - **Connections**: For pro accounts, you can reach out to other contributors and maintainers to collaborate on projects or to learn from them.
 - **Recommendations**: This tab includes a list of open source projects that are chosen based on the programming languages you picked in the "Interests" section of your public profile. It is useful if you're looking for new projects to contribute to.

 ## Explore: Finding Your Next Open Source Project

 The "Explore" tab is a great place to start if you're looking for a new open source project to contribute to or want to find repositories for potential job opportunities. Here, you can find a list of open source projects and filter them by language, top repos, recent, most active, and more.

-Once you've selected your filters, you'll be able to see the contributors, spam, and activity levels of the repository. Understanding the activity level and PR velocity of a repository can help you determine if it's a good fit for you to contribute to and what to expect when you submit a PR.
+Once you've selected your filters, you'll be able to see the contributors, spam, and activity levels of the repository. Understanding a repository's activity level and PR velocity can help you determine if it's a good fit for you to contribute to and what to expect when you submit a PR.


Just a note:

We might want to revisit this. I'm not sure here are we talking about the higher view (Contributors, Spam, Merged PRs, and Unlabeled PRs) or the data in the Repositories.

docs/maintainers/maintainers-guide.md

adiati98 · 2024-03-05T10:32:01Z

@BekahHW

I already have a screenshot to replace the one in "Activity" tab in this comment.
But we can do this in next PR if you will.

If you've reviewed and approved the changes here, I think we can merge this in before it's getting much longer and more difficult to follow. Let's do the unresolved suggestions in the following PRs. Thank you😊

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

### [1.66.2](v1.66.1...v1.66.2) (2024-03-05) ### Bug Fixes * format and wording adjustments in workspaces, contributors and repo insights sections ([#262](#262)) ([37bddac](37bddac))

adiati98 added 13 commits February 27, 2024 21:34

fix: wording in workspaces.md

17d59e4

fix: wording and format in contributors-guide.md

d79065b

fix: format and wording in repo-insights.md

b59ac79

fix: incorrect link and wording in contributor-insights.md

e54af03

fix: add connections to the sidebar

a344a52

fix: format and title capitalization in connections.md

02807ac

feat: add info helper in introduction.md

97fdf7f

fix: wording adjustment in categorize-contributions.md

bc1e30f

fix: capitaliazation and add punctuations in job seekers intro

cfccdb4

fix: change term to PR for consistency in categorize-contributions.md

99c811f

fix: minor wording adjustment in repo-insights.md

7fea06f

fix: link to repo insights for contributor in repo-insights.md

874b32b

fix: revert a link

6e8e1a7

BekahHW reviewed Feb 28, 2024

View reviewed changes

sidebars.js Outdated Show resolved Hide resolved

fix: remove connections from sidebar

7ce6801

adiati98 changed the title ~~fix: format and wording adjustments in workspaces and the accompanying sections~~ fix: format and wording adjustments in workspaces, contributors and repo insights sections Feb 28, 2024

fix: typo in connections.md

24a53fd

adiati98 commented Feb 28, 2024

View reviewed changes

adiati98 marked this pull request as ready for review February 28, 2024 19:08

adiati98 requested a review from BekahHW February 28, 2024 19:08

Update docs/features/workspaces.md

cb65ae0

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

BekahHW reviewed Feb 28, 2024

View reviewed changes

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

Update docs/features/workspaces.md

41f97b9

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

BekahHW requested changes Feb 28, 2024

View reviewed changes

adiati98 added 3 commits February 28, 2024 20:42

fix: change tip to note in workspaces.md

97f793d

fix: adjust intro paragraph wording in workspaces.md

07b56a0

Merge branch 'fix/workspaces' of https://github.com/open-sauced/docs …

5925ce0

…into fix/workspaces

adiati98 requested a review from BekahHW February 28, 2024 19:47

adiati98 requested a review from a team as a code owner March 3, 2024 00:07

adiati98 added 2 commits March 3, 2024 23:16

fix: capitalization and minor wording in workspaces.md

1c80cf9

fix: minor wording in understanding repo and contrib data

ff12f01

adiati98 commented Mar 3, 2024

View reviewed changes

docs/maintainers/maintainers-guide.md Show resolved Hide resolved

adiati98 and others added 12 commits March 4, 2024 13:02

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

817bd8b

…orkspaces

fix: wording, remove a link and capitalizations in maintainers-guide.md

c470748

fix: minor wording in understanding-repo-insights.md

fec21e9

fix: adjust wording and add alert in contributors-guide.md

c72c1b2

fix: capitalizations and adjust wording

9ae9565

fix: order in creating a new contrib page section

773af1d

fix: change unordered list to subsections in Using Your Contributor I…

2590e09

…nsights Page of contributors-guide.md

fix: change Contributor to Highlights section in maintainers-guide.md

a22d34e

feat: add note alert for understand more about data provided

d4261fd

feat: add workspace switcher image

c17ab5b

feat: add workspace switcher link to workspaces.md

1c60bd1

fix: replace section term with feature

49eb4a4

adiati98 commented Mar 4, 2024

View reviewed changes

CBID2 mentioned this pull request Mar 4, 2024

Feature: change screenshot in "Activity" subsection #270

Closed

3 tasks

adiati98 commented Mar 4, 2024

View reviewed changes

docs/maintainers/maintainers-guide.md Outdated Show resolved Hide resolved

BekahHW mentioned this pull request Mar 4, 2024

Add section on paid features #256

Closed

BekahHW and others added 2 commits March 5, 2024 10:11

Update docs/contributors/contributors-guide.md

2bf1fb8

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

Update docs/maintainers/maintainers-guide.md

e338c8f

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

BekahHW approved these changes Mar 5, 2024

View reviewed changes

BekahHW merged commit 37bddac into main Mar 5, 2024
11 checks passed

BekahHW deleted the fix/workspaces branch March 5, 2024 15:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: format and wording adjustments in workspaces, contributors and repo insights sections #262

fix: format and wording adjustments in workspaces, contributors and repo insights sections #262

adiati98 commented Feb 28, 2024 •

edited

netlify bot commented Feb 28, 2024 •

edited

adiati98 left a comment

BekahHW left a comment

adiati98 commented Feb 28, 2024

adiati98 left a comment

adiati98 Mar 3, 2024 •

edited

BekahHW Mar 5, 2024

adiati98 Mar 4, 2024

BekahHW Mar 4, 2024

adiati98 Mar 4, 2024 •

edited

CBID2 Mar 4, 2024

adiati98 Mar 4, 2024

adiati98 commented Mar 5, 2024

fix: format and wording adjustments in workspaces, contributors and repo insights sections #262

fix: format and wording adjustments in workspaces, contributors and repo insights sections #262

Conversation

adiati98 commented Feb 28, 2024 • edited

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 28, 2024 • edited

✅ Deploy Preview for docs-open ready!

adiati98 left a comment

Choose a reason for hiding this comment

BekahHW left a comment

Choose a reason for hiding this comment

adiati98 commented Feb 28, 2024

adiati98 left a comment

Choose a reason for hiding this comment

adiati98 Mar 3, 2024 • edited

Choose a reason for hiding this comment

BekahHW Mar 5, 2024

Choose a reason for hiding this comment

adiati98 Mar 4, 2024

Choose a reason for hiding this comment

BekahHW Mar 4, 2024

Choose a reason for hiding this comment

adiati98 Mar 4, 2024 • edited

Choose a reason for hiding this comment

CBID2 Mar 4, 2024

Choose a reason for hiding this comment

adiati98 Mar 4, 2024

Choose a reason for hiding this comment

adiati98 commented Mar 5, 2024

adiati98 commented Feb 28, 2024 •

edited

netlify bot commented Feb 28, 2024 •

edited

adiati98 Mar 3, 2024 •

edited

adiati98 Mar 4, 2024 •

edited