Skip to content

Commit

Permalink
Vale fixes, RST fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@RCheesley
RCheesley committed Oct 22, 2024
1 parent d9ef8b9 commit df53a62
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 35 deletions.
64 changes: 29 additions & 35 deletions ...ibuting/12.google-summer-of-code/docs.rst → docs/contributing/google_summer_of_code.rst
View file
Original file line number Diff line number Diff line change
@@ -1,29 +1,31 @@
.. image:: Summer-of-Code-Twitter.png
.. image:: images/Summer_of_Code.png
:width: 600

Google Summer of Code at Mautic
###############################

This page contains information about Mautic’s participation in Google Summer of Code (GSoC). Please feel free to contact us via Slack below for clarifications and more information.
This page contains information about Mautic's participation in Google Summer of Code, often abbreviated to GSoC. Please feel free to contact us via Slack below for clarifications and more information.

Check warning on line 7 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 7, "column": 6}}}, "severity": "INFO"}

Check warning on line 7 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Contact' instead of 'contact'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Contact' instead of 'contact'.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 7, "column": 134}}}, "severity": "INFO"}

Check warning on line 7 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'us'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'us'.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 7, "column": 142}}}, "severity": "WARNING"}

What can I do today?

Check warning on line 9 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.FirstPerson] Avoid first-person pronouns such as ' I '.

Raw Output:
{"message": "[Google.FirstPerson] Avoid first-person pronouns such as ' I '.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 9, "column": 9}}}, "severity": "WARNING"}
--------------------
********************

Today you should read through the ideas for projects, and start working on your application. Get familiar with Mautic, make some contributions so you’re familiar with the workflow, and get to know the community. Join the :xref:`Mautic Community Slack` channel (#gsoc-discuss) and post any questions you have there, after reading this page fully and also reviewing the project proposals.
Today you should read through the ideas for projects, and start working on your application. Get familiar with Mautic, make some contributions so you're familiar with the workflow, and get to know the community. Join the :xref:`Mautic Community Slack` channel - #gsoc-discuss - and post any questions you have there, after reading this page fully and also reviewing the project proposals.

Check warning on line 12 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'app' instead of 'application'.

Raw Output:
{"message": "[Google.WordList] Use 'app' instead of 'application'.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 12, "column": 81}}}, "severity": "WARNING"}

Check warning on line 12 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Channel' instead of 'channel'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Channel' instead of 'channel'.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 12, "column": 253}}}, "severity": "INFO"}

Check warning on line 12 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 12, "column": 337}}}, "severity": "INFO"}

Student Information
-------------------
*******************

Do you want to contribute to one of the world’s first Open Source Marketing Automation platform? GSoC could be your chance. Please refer to the information below.
Do you want to contribute to one of the world's first Open Source Marketing Automation platform? GSoC could be your chance. Please refer to the information below.

If you’re interested in working on a mentor-submitted idea, read the :xref:`GSOC project ideas` and about the project and the related technology. Please note this is a rolling document which we maintain year-round. There is no need to contact the mentor unless you have a specific question about the project. Don’t send an “I’m interested” email or Slack message - please respect their time.
If you're interested in working on a mentor-submitted idea, read the :xref:`GSOC project ideas` and about the project and the related technology. Please note this is a rolling document which we maintain year-round. There is no need to contact the mentor unless you have a specific question about the project. Don't send an “I'm interested” email or Slack message - please respect their time.

Check warning on line 19 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'GSOC', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'GSOC', if it's unfamiliar to the audience.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 19, "column": 77}}}, "severity": "INFO"}

Check warning on line 19 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'we'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 19, "column": 192}}}, "severity": "WARNING"}

Check warning on line 19 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Contact' instead of 'contact'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Contact' instead of 'contact'.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 19, "column": 236}}}, "severity": "INFO"}

If you’re interested in proposing your own project start looking around the Mautic Project for a mentor and suggest your idea in the :xref:`Mautic Assembly`.
If you're interested in proposing your own project start looking around the Mautic Project for a mentor and suggest your idea in the :xref:`Mautic Assembly`.

You may also wish to start working on the Mautic-specific parts of the application, see below for more information. Carefully review the student responsibilities section.

Why spend your summer working on FOSS?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**************************************

When you work in the open on free software, you create a body of work that follows you for the rest of your life. Rather than a coding assignment done by thousands of other students and relegated to the bottom of the drawer at semester’s end, working in FOSS is a chance to contribute to a living project.
When you work in the open on free software, you create a body of work that follows you for the rest of your life. Rather than a coding assignment done by thousands of other students and relegated to the bottom of the drawer at semester's end, working in FOSS is a chance to contribute to a living project.

Working in FOSS gives you a chance to:

Expand All @@ -36,34 +38,34 @@ Working in FOSS gives you a chance to:
- Create lifetime connections and associations.

Why work with Mautic?
~~~~~~~~~~~~~~~~~~~~~
*********************

Our project is relatively young and has a small but active contributor base - you have the chance to really make a difference to our community and project. We are a welcoming, friendly and diverse community.

People who contribute in our community and do good work are noticed. They get hired for jobs from it. Experience and reputation in the Mautic Project communities can be influential in your career in many ways.

You should know that contributing to FOSS doesn’t require you to have super programming skills, or super-anything else. You just need be interested, curious, and willing to become comfortable being productively lost. This is the state of learning. You learn by finding your way around and figuring things out with the support of your mentor and the community.
You should know that contributing to FOSS doesn't require you to have super programming skills, or super-anything else. You just need be interested, curious, and willing to become comfortable being productively lost. This is the state of learning. You learn by finding your way around and figuring things out with the support of your mentor and the community.

Student Responsibilities
~~~~~~~~~~~~~~~~~~~~~~~~
************************

You are the key ingredient for your project’s success. This project is important to you, your mentor, and the entire Mautic Community.
You are the key ingredient for your project's success. This project is important to you, your mentor, and the entire Mautic Community.

Your responsibilities include:

- Communicating early and often with your mentor.
- Updating every week about what you’re learning, how you’re doing, challenges and successes. This is key way to keep the entire Mautic Community informed.
- Updating every week about what you're learning, how you're doing, challenges and successes. This is key way to keep the entire Mautic Community informed.
- Working with your mentor on realistic achievable milestones that provide for regular deliverables and feedback.

Check failure on line 58 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'deliverables'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'deliverables'?", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 58, "column": 88}}}, "severity": "ERROR"}
- Attending the brief student calls, as announced
- Being accountable for your success and your actions

Student Application
~~~~~~~~~~~~~~~~~~~
*******************

Please read and follow the student application process below.

Google Summer of Code Application Process
-----------------------------------------
=========================================

Interested in applying for Google Summer of Code with Mautic? Here is how you do that!

Check failure on line 70 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Exclamation] Don't use exclamation points in text.

Raw Output:
{"message": "[Google.Exclamation] Don't use exclamation points in text.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 70, "column": 85}}}, "severity": "ERROR"}

Expand All @@ -73,7 +75,7 @@ Important
---------

- Timelines are set by Google for the entire program. Follow the timeline.
- Applications are due in Google’s system by April 2 2024 - 18:00 UTC.
- Applications are due in Google's system by April 2 2024 - 18:00 UTC.
- Applications must be filed in the Google system. No other material can be read or accepted.
- The final application is required to be submitted as a PDF.

Expand All @@ -92,13 +94,13 @@ These links may be helpful:
Communicate
~~~~~~~~~~~

Begin communicating with the community. Our community members can help you understand the existing project proposals. If you’re going to try and propose your own project, this is a great way to understand the needs of the project and find a mentor.
Begin communicating with the community. Our community members can help you understand the existing project proposals. If you're going to try and propose your own project, this is a great way to understand the needs of the project and find a mentor.

- Join us on :xref:`Mautic Community Slack` at #gsoc-discuss
- Join the Product Team chat in #t-product
- Join us on :xref:`Mautic Community Slack` at ``#gsoc-discuss``
- Join the Product Team chat in ``#t-product``
- Get involved with our weekly Open Source Friday sprints by testing bug fixes and new features

Don’t forget to contact mentors on projects that interest you to learn more. If you’re going to propose a project you must have a mentor at the time of proposal.
Don't forget to contact mentors on projects that interest you to learn more. If you're going to propose a project you must have a mentor at the time of proposal.

Apply
~~~~~
Expand All @@ -115,15 +117,15 @@ Help is available! Share your application in progress and get feedback. The ment

If you are submitting an original proposal you **must** find a mentor. Proposals without mentors will be rejected. Sharing your proposal is key to doing this.

If you don’t want to share your proposal publicly consider using something like a Google Doc and sharing a link with the mentor/reviewers.
If you don't want to share your proposal publicly consider using something like a Google Doc and sharing a link with the mentor/reviewers.

Google Summer of Code Application and Supplemental Material Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------

In addition to the information Google requests, the Mautic Project requires you to submit the following information:

- What project are you applying to? Seriously consider choosing a project for proposal from ideas list. While it is possible to propose your own project, it is often more successful for you to select one that is already proposed by a mentor.
- Contact Information - List your Name, Email Address, Blog URL, and any additional contact information you think we need. We tend to email so be sure you’re reading your email.
- Contact Information - List your Name, Email Address, Blog URL, and any additional contact information you think we need. We tend to email so be sure you're reading your email.
- About You - Consider these questions

- Do you have any past involvement with the Mautic Project or another Open Source project as a contributor? What kind of contributions have you made (code and non-code)? Please share any public contributions you have made (urls, etc.)

Check failure on line 131 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'URLs' instead of 'urls'.

Raw Output:
{"message": "[Vale.Terms] Use 'URLs' instead of 'urls'.", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 131, "column": 226}}}, "severity": "ERROR"}
Expand All @@ -147,16 +149,8 @@ In addition to the information Google requests, the Mautic Project requires you
- Propose a rough schedule for this project. Ideally you will have regular deliverables throughout the entire period.

Check failure on line 149 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'deliverables'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'deliverables'?", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 149, "column": 76}}}, "severity": "ERROR"}
- What are you specific plans from May to September (eg: Exams in university, internships, vacations..etc). We need to know if there are periods of time where you are likely to be unavailable. We are better at accommodating these periods if we know of them in advance.

Check failure on line 150 in docs/contributing/google_summer_of_code.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'eg'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'eg'?", "location": {"path": "docs/contributing/google_summer_of_code.rst", "range": {"start": {"line": 150, "column": 54}}}, "severity": "ERROR"}

..
You must submit a PDF version of all of the information you
prepare with your application using the Google site. The PDF
should consist of the information from the supplemental
application requirements section below. It should also contain
any custom project you are proposing, if any. We are not
allowed to consider students who do not submit this PDF.
Students will not be judged on the visual layout of their PDF,
however all information must be readable.
You must submit a PDF version of all of the information you prepare with your application using the Google site. The PDF should consist of the information from the supplemental application requirements section below. It should also contain any custom project you are proposing, if any. We are not allowed to consider students who do not submit this PDF.
Students will not be judged on the visual layout of their PDF, however all information must be readable.

Keep communicating
~~~~~~~~~~~~~~~~~~
Expand Down
0 ...summer-of-code/Summer-of-Code-Twitter.png → docs/contributing/images/Summer_of_Code.png
View file
File renamed without changes

0 comments on commit df53a62

Please sign in to comment.