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

Resolving issue 1696 #1797

Merged
merged 5 commits into from
Jun 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/source/getting-started/Welcome.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
Hi Newcomer!
Welcome to CHAOSS!
===============

CHAOSS is an open source community dedicated to creating software/metrics/programs that measures and maintains the overall health of open source community health. Health in the aspect of community engagement, good code metrics, inclusivity, etc.

Now, as a new member, it can be overwhelming to navigate and sift through all that information -it was for me, so I’m writing this as a guide since the steps helped me out. I'm hoping it helps you and makes your onboarding a little easier.

A few first things to do:

1) Join the slack channel, that's the fastest way to join and be a part of the community.
.. image:: images/slack.jpg
:width: 400
:alt: "Slack image"

2) Introduce yourself to the #newcomers channel. Say hi, it’d help others get to know you and point you in the right direction. In case you’re unsure, here’s a format you can use:
· Name
· If you’re participating/contributing through an organization mention it here.
· What you think you’d like to contribute to
· Whatever other sentiments you’d like to add.
Example: Hi, my name is Precious Onyewuchi. I’m an outreachy intern contributing to the documentation. It’s super exciting to figure out the value I can get from being a member of this community and how much value I can contribute too.

.. image:: images/chaoss_slack_workspace.png
:width: 400
:alt: "Slack image"

This is a picture of my own introduction. Some parts of the image were blurred for privacy reasons

3) As a follow-up for number two (2), if you’re contributing from a program (e.g Outreachy, or GSOC), find the respective channel for your program and join it. It’d be easier to get questions regarding that program answered and you can see other people like you in the same program to interact with and get help from. The channel for GSOC is #gsoc, and the channel for Outreachy is #outreachy, #general is for general questions and #augur is for stuff designated to augur, (e.g Installation (i figured that last part a little later. So, you’re welcome!)
.. image:: images/channels.png
:width: 400
:alt: "Slack image"

4) When in these channels, links to what is expected of you would be posted (it’d mostly lead to a Github repo). Read it carefully, and understand what is expected of you. The words in bold are important because as a new person, it’s completely normal to get lost in the community and end up doing what isn’t expected of you (i did it); especially for Outreachy and GSOC participants. Truth is, as much as the project is an interesting one and might make you have a bunch of interests you want to contribute to, your time as a contributor under these programs is limited, so for the duration of the program, you want to at least make sure you do what is expected of you. After the program, you can decide to fully be a contributor.
.. image:: images/project_description.PNG
:width: 400
:alt: "Slack image"
--------------------Picture of my cohort’s instructions-----------------------

5) After understanding the expectations, try your best to do them.
.. image:: images/contribution.png
:width: 400
:alt: "Slack image"
--------------------Pictures of expectations during my time.--------------------

6) The mentors are available to help you on the slack channels if you have any questions or there is some form of confusion. They might change at program intervals, but they’d definitely be communicated to you on the project description of your program page. Also, if you’re unsure, just ask your question on the Slack channel, someone will definitely give you an answer.

Thank you, i hope this helps and makes your open source journey a little easier and more enjoyable!
WELCOME TO CHAOSS!🎉

.. image:: images/chaoss.png
:width: 400
:alt: "Slack image"
Binary file added docs/source/getting-started/images/channels.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/getting-started/images/chaoss.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/getting-started/images/image1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/getting-started/images/slack.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/source/quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ PostgreSQL Installation

.. code-block:: bash

$ sudo service postgresql start
$ sudo su -
$ su - postgres
$ psql
Expand Down Expand Up @@ -129,6 +130,17 @@ Two of Augur's workers use the Go programming language, which needs to be instal
sudo apt install snapd
sudo snap install go --classic

Incase you encounter any problem following the above commands, try doing these first:

.. code-block:: bash

sudo apt-get update && sudo apt-get install -yqq daemonize dbus-user-session fontconfig
sudo daemonize /usr/bin/unshare --fork --pid --mount-proc /lib/systemd/systemd --system-unit=basic.target
exec sudo nsenter -t $(pidof systemd) -a su - $LOGNAME
snap version

If the last command returns successfully, you can try installing Go again using either of the two options above.

Python Virtual Environment Configuration
~~~~~~~~~~~~~~~~~~~~~~~~
- Set up a Python virtual environment (Python 3.8 and above are now required. Python 3.9 and python 3.10 work as well, though we have tested Python 3.9 on more platforms.)
Expand Down
Loading