[Feature] Quick Start Guides for Contributors

[Silvia-Wachira]

Problem

New contributors often encounter challenges related to the environment setup, which can discourage participation and slow down contributions.The existing documentation could use instructions for beginners to set up the project locally though there is a challenge in making the README.md complex.

Description

While the current README provides valuable information about the project, It would be beneficial to also have a file that would have Quick set up instructions and common issues or FAQs for new contributers. This issue is related to issue #110.

One example is a guide for installing Jekyll and any dependencies.

Alternatives

Expanding the README.md will make it overly long and complex and important information could get buried under excessive detail

Implementation

• I would be interested in implementing this feature.

[possumbilities]

I think this is well beyond the scope of the material we'd want to have here. However, there might be some use in adequately linking to our Foundational Technologies page the way we do here:

• https://github.com/creativecommons/vocabulary?tab=readme-ov-file#setup--development

And, also submitting a PR for the open source website to add pre-existing guides for the use of Jekyll that could be useful.

• https://github.com/creativecommons/creativecommons.github.io-source
• https://opensource.creativecommons.org/contributing-code/foundational-tech/

Anyone else have thoughts?

[Silvia-Wachira]

Let me ask for different ideas in the Slack channel

[Vanessa082]

@Silvia-Wachira @possumbilities

I appreciate the discussion about improving the onboarding experience for new contributors. I strongly agree with the idea of creating a separate Quick Start Guide. This can help streamline the essential setup instructions and frequently asked questions without overwhelming newcomers with too much detail in the main README.md.
Also, It's crucial to ensure that the guide uses clear, beginner-friendly language. New contributors may not be familiar with technical jargon, so simplifying terms or providing explanations where necessary can make a big difference.
including links to external resources. This will keep our main documentation clean while still providing access to valuable information.

[Vanessa082]

I think inviting existing contributors to share their experiences in the new Quick Start Guide is a wonderful way to provide real-world insights. This can enrich the content and make it even more relevant to newcomers.
Also, it might be helpful to create a feedback mechanism for new contributors to share their experiences with the setup process. This could inform future updates to the documentation and help us identify common pain points.
Overall, I believe these improvements could foster a more welcoming environment for new contributors and enhance their experience as they navigate the setup process. I'm looking forward to seeing how we can implement these suggestions!

Hope I am not out of topic

[Silvia-Wachira]

@Vanessa082 Thank you for your input and no you are not out of topic. I actually agree with you because I had a hard time getting started with the project and that is why I thought of a quick start guide.