docs icon indicating copy to clipboard operation
docs copied to clipboard

docs: add growing your project section

Open CBID2 opened this issue 10 months ago • 14 comments

Description

This PR adds a section to the Maintainers Guide on growing open source projects. It will give maintainers an idea on how OpenSauced can help them with this process.

What I have done so far

  • [x] Add growing-your-project.md to docs > maintainers

  • [x] In sidebar.js, add `maintainers/growing-your-project' path below the guide: "maintainers/maintainers-guide-to-open-sauced",

  • [x] In growing-your-project.md, create the following sections:

    • [x] When to grow your project (brief explanation of need to get more contributors or add people to teams (maintainers, triage, docs)

    • [x] How to identify new contributors and team members

      • [x] Look at existing contributors. How is there participation? Are they engaged? Are they invested in the success of the project?
      • [x] Create an insight page with your projects. Add the most active contributors to a list.
    • [x] Recruiting team members and contributors

      • [x] Create an insight page with projects similar to yours. Add contributors you think might be a good fit to a list. After spending some time monitoring, reach out to them.
    • [x] Understanding Team Participation.

      • [x] It's important to monitor team participation. Once you have someone on a team, add them to your list to monitor your participation. (Use the team sync feature -- link to the gif). It's useful to set a timeframe for how active they need to be.

Related Tickets & Documents

Closes #235

Mobile & Desktop Screenshots/Recordings

Steps to QA

Tier (staff will fill in)

  • [ ] Tier 1
  • [ ] Tier 2
  • [ ] Tier 3
  • [ ] Tier 4

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

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

CBID2 avatar Apr 03 '24 21:04 CBID2

Deploy request for docs-open pending review.

Visit the deploys page to approve it

Name Link
Latest commit 7c94f1415b08a715dab2da96a7fc7b16691bd04e

netlify[bot] avatar Apr 03 '24 21:04 netlify[bot]

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

BekahHW avatar Apr 24 '24 15:04 BekahHW

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

How do I install the new dependencies @BekahHW?

CBID2 avatar Apr 24 '24 20:04 CBID2

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

How do I install the new dependencies @BekahHW?

Just run npm ci as mentioned on the README after you pull the changes, @CBID2.

Then, don't forget to run it locally to test if it works.

adiati98 avatar Apr 25 '24 06:04 adiati98

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

How do I install the new dependencies @BekahHW?

Just run npm ci as mentioned on the README after you pull the changes, @CBID2.

Then, don't forget to run it locally to test if it works.

@adiati98, I got this error when I did the commands:

rror: Unsupported engine
    at checkEngine (/home/gitpod/.npm/_npx/6cea267ee22d4a04/node_modules/npm-install-checks/index.js:15:25)
    at Object.<anonymous> (/home/gitpod/.npm/_npx/6cea267ee22d4a04/node_modules/@open-sauced/check-engines/index.js:13:1)
    at Module._compile (node:internal/modules/cjs/loader:1369:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1427:10)
    at Module.load (node:internal/modules/cjs/loader:1206:32)
    at Module._load (node:internal/modules/cjs/loader:1022:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:135:12)
    at node:internal/main/run_main_module:28:49 {
  pkgid: '@open-sauced/docs.opensauced.pizza',
  current: { node: '20.12.2', npm: '10.5.0' },
  required: { node: '^18', npm: '>=9' },
  code: 'EBADENGINE'
}

CBID2 avatar Apr 25 '24 19:04 CBID2

@CBID2 what have you tried to fix the error?

BekahHW avatar Apr 25 '24 19:04 BekahHW

@CBID2 what have you tried to fix the error?

Kill the terminal and do the steps again @BekahHW.

CBID2 avatar Apr 25 '24 19:04 CBID2

@CBID2 have you tried to google the error message?

adiati98 avatar Apr 25 '24 19:04 adiati98

@CBID2 have you tried to google the error message?

Doing that now

CBID2 avatar Apr 25 '24 19:04 CBID2

@CBID2 have you tried to google the error message?

Doing that now

It's good practice to start by googling or asking chatGPT to help you navigate the error. Here's a Virtual Coffee Guide that might help you develop a process for navigating errors.

BekahHW avatar Apr 25 '24 19:04 BekahHW

@CBID2 have you tried to google the error message?

Doing that now

It's good practice to start by googling or asking chatGPT to help you navigate the error. Here's a Virtual Coffee Guide that might help you develop a process for navigating errors.

I got it to work @BekahHW and @adiati98! :) It turns out I had to downgrade my version of Nodejs. Should we go onto reviewing my PR now?

CBID2 avatar Apr 25 '24 20:04 CBID2

@CBID2 when you feel like things are ready, please mark the PR as "Ready for Review"

BekahHW avatar Apr 26 '24 14:04 BekahHW

@CBID2 when you feel like things are ready, please mark the PR as "Ready for Review"

I'm ready now @BekahHW.

CBID2 avatar Apr 27 '24 01:04 CBID2

Hey @BekahHW and @adiati98. I made a small update to the guide since the StarSearch feature has been released. Check them out when you can.

CBID2 avatar May 09 '24 22:05 CBID2

@CBID2, Have you run and test this locally? Because when I run this locally, I see this:

Screenshot 2024-05-27 164933

adiati98 avatar May 27 '24 14:05 adiati98

@CBID2, Have you run and test this locally? Because when I run this locally, I see this:

Screenshot 2024-05-27 164933

Hey @adiati98. I made the change and ran it locally. Here's how it looks screenshot of note

CBID2 avatar May 27 '24 17:05 CBID2

Hey @CBID2,

We noticed that you have some unverified commits in your PR.

Can you look into what's going on with this? Here's the GH docs on verification.

image

BekahHW avatar May 28 '24 14:05 BekahHW

Hey @CBID2,

We noticed that you have some unverified commits in your PR.

Can you look into what's going on with this? Here's the GH docs on verification. image

Hey @BekahHW. I have been switching between using VS.Code's Source Control and the terminal to push my commits.

CBID2 avatar May 29 '24 01:05 CBID2

Hey @CBID2, We noticed that you have some unverified commits in your PR. Can you look into what's going on with this? Here's the GH docs on verification. image

Hey @BekahHW. I have been switching between using VS.Code's Source Control and the terminal to push my commits.

Looks like you might need to set it up in one of them.

BekahHW avatar Jun 03 '24 15:06 BekahHW

Hey @CBID2, I converted this to a draft until you have some time to go through the comments and create a revision strategy.

BekahHW avatar Jun 03 '24 15:06 BekahHW

Deploy Preview for saucedocs ready!

Name Link
Latest commit d68ea0447236aee21a641717608d534cb4d4b209
Latest deploy log https://app.netlify.com/sites/saucedocs/deploys/665de688c5f3a400084296e7
Deploy Preview https://deploy-preview-291--saucedocs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

netlify[bot] avatar Jun 03 '24 15:06 netlify[bot]

Hey @CBID2, I converted this to a draft until you have some time to go through the comments and create a revision strategy.

Hi @BekahHW. I created a new PR for this issue. It's #324

CBID2 avatar Jun 04 '24 20:06 CBID2