Skip to content

Commit

Permalink
More Vale fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@RCheesley
RCheesley committed Nov 4, 2024
1 parent 8b91465 commit 7bc88c0
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 20 deletions.
7 changes: 7 additions & 0 deletions docs/links/mautic_product_team_slack.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "Mautic product team Slack"
link_text = "#t-product on Slack"
link_url = "https://mautic.slack.com/archives/CQMKV0RU1"

link.xref_links.update({link_name: (link_text, link_url)})
51 changes: 31 additions & 20 deletions docs/teams/product_team/product_team_overview.rst
View file
Original file line number Diff line number Diff line change
@@ -1,59 +1,70 @@
Product Team

Check warning on line 1 in docs/teams/product_team/product_team_overview.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Headings] 'Product Team' should use sentence-style capitalization.

Raw Output:
{"message": "[Google.Headings] 'Product Team' should use sentence-style capitalization.", "location": {"path": "docs/teams/product_team/product_team_overview.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
############

Missions and Expectations for the Product Team
************************************************
.. vale off
Missions and expectations for the Product Team
**********************************************

.. vale on
Manage all aspects of the product release cycle and roadmap for the Mautic Open Source project.

Security
------------
Managing Mautic's security
--------------------------

* Manage the :xref:`Mautic Mail` inbox.
* Monitor dependency updates for potential security issues.
* Address security issues via pull requests on the private security repository.
* Release security patches or coordinate with the Release Working Group for security fixes.
* Maintain a historical list of security advisories.

Releases
---------
.. vale off
* Oversee the release timeline once a release is confirmed, including defining the testing period, locking assigned pull requests, merging, packaging, and conducting pre-release and release activities.
Managing Mautic's releases
--------------------------

.. vale on
* Oversee the release timeline once confirmed including defining the testing period, locking assigned pull requests, merging, packaging, and conducting pre-release and release activities.
* Test pull requests and review code included in the release.
* Establish criteria for testing, quality assurance, and ensure all code adheres to coding standards.

Coding
--------
------

* Develop features requested by the Roadmap and Features Definition Working Group.
* Review pending pull requests.
* Resolve reported issues.

Features Definitions
---------------------
Features definitions
--------------------

* Benchmark competitors.
* Stay informed on market trends.
* Define user stories for new features.

Check warning on line 45 in docs/teams/product_team/product_team_overview.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 'User' instead of 'user'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'User' instead of 'user'.", "location": {"path": "docs/teams/product_team/product_team_overview.rst", "range": {"start": {"line": 45, "column": 10}}}, "severity": "INFO"}

Roadmap Design
---------------
Roadmap design
--------------

* Technical Roadmap (Security and Patches):
* Technical Roadmap - Security and Patches:
* Prioritize bug fixes and issues.
* Establish a patch release schedule.

* Feature Roadmap (Minor & Major Versions):
* Feature Roadmap - Minor & Major Versions:
* Prioritize feature development in coordination with the Feature Definition Working Group.
* Define release cadence and long-term support (LTS) versions.

Check warning on line 56 in docs/teams/product_team/product_team_overview.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/teams/product_team/product_team_overview.rst", "range": {"start": {"line": 56, "column": 51}}}, "severity": "INFO"}

Check warning on line 56 in docs/teams/product_team/product_team_overview.rst

View workflow job for this annotation

GitHub Actions / prose 

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

Raw Output:
{"message": "[Google.Acronyms] Spell out 'LTS', if it's unfamiliar to the audience.", "location": {"path": "docs/teams/product_team/product_team_overview.rst", "range": {"start": {"line": 56, "column": 52}}}, "severity": "INFO"}

Profiles of Contributors Needed in This Team
*********************************************
Profiles of contributors needed in this team
********************************************

The product team needs individuals with the following skills and expertise:

* Developers/Engineers
* Marketers (for Features Definition Working Group)
* Mautic users (for testing within the Releases Working Group)
* Project Coordinators (to support Releases and Roadmap Design Working Groups)
* Marketers - for features definition
* Mautic users - for testing within the Releases Working Group

Check warning on line 65 in docs/teams/product_team/product_team_overview.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 'Users' instead of 'users'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Users' instead of 'users'.", "location": {"path": "docs/teams/product_team/product_team_overview.rst", "range": {"start": {"line": 65, "column": 10}}}, "severity": "INFO"}
* Project Coordinators - to support Releases Working Groups

**Interested in joining this team?**

**Interested in joining this team?** Connect with us on Slack at `#t-product Slack channel <https://mautic.slack.com/archives/CQMKV0RU1>`_!
Connect with us on Slack at :xref:`Mautic product team Slack`.

Check warning on line 70 in docs/teams/product_team/product_team_overview.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/teams/product_team/product_team_overview.rst", "range": {"start": {"line": 70, "column": 14}}}, "severity": "WARNING"}

0 comments on commit 7bc88c0

Please sign in to comment.