Fix: remove write-good

.pre-commit-config.yaml

@@ -37,3 +37,8 @@ repos:
     rev: v2.3.0
     hooks:
     - id: codespell
+
+  - repo: https://github.com/errata-ai/vale
+    rev: v3.7.0
+    hooks:
+      - id: vale

.vale.ini

@@ -0,0 +1,32 @@
+# Configuration file for using Vale in the python-package-guide repository
+#
+# To disable checks on parts of a MarkDown or HTML file, delimit the section
+# using these HTML comments:
+#     to disabled Vale checks after this line: <!-- vale off -->
+#     to enable Vale checks after this line: <!-- vale on -->
+#
+# To disable checks based on MarkDown scope, see IgnoredScopes.
+# To disable checks on certain HTML elements, see IgnoredClasses.
+#
+# More information about the configuration can be found here:
+# https://vale.sh/docs/topics/config
+
+
+# Path to the styles directory, where style rules are defined
+StylesPath = vale-styles
+
+# Path to a dictionary folders inside the StylesPath config subdirectory. This
+# folder can contain two files, accept.txt and reject.txt, with one word per
+# line. These words will be used to check for spelling mistakes in addition to
+# the internal dictionary, if the 'Vale' ruleset is enabled (see below)
+# See https://vale.sh/docs/topics/vocab/#folder-structure for more details
+Vocab = sample
+
+
+# Checks are defined in sections by file type, like the one below for
+# MarkDown. In each section you can enable groups of style rules, defined in folders
+# inside the StylesPath directory.
+# Use 'Vale' to enable the internal style rules and checks.
+
+[*.md]
+BasedOnStyles = pyos-styles

community/index.md

@@ -1,15 +1,26 @@
-# Organization Handbook
+# Community Handbook
+
+pyOpenSci has built a vibrant open science community of practice. This
+community:
+
+1. helps scientists develop the open science skills needed to make their workflows more open and collaborative.
+2. runs a Python software peer review process that reviews scientific software.
+3. partners and leverage the work of other communities so we can learn and move forward together.
+
+In this section of the handbook, we describe the platforms, processes and
+approaches that we use to engage with both scientists and the broader
+scientific Python community.
 
 :::{toctree}
-:hidden:
-:caption: Social Media Section
+:maxdepth: 2
+:caption: Social Media
 
 Social Media <social>
 Slack <slack>
 :::
 
 :::{toctree}
-:hidden:
+:maxdepth: 2
 :caption: GitHub Processes
 
 GitHub <github/intro>
@@ -20,7 +31,7 @@ Continuous Integration (CI) <github/continuous-integration>
 :::
 
 :::{toctree}
-:hidden:
+:maxdepth: 2
 :caption: pyOpenSci Events
 
 Events <events/intro>

reference/index.md

@@ -3,8 +3,6 @@
 pyOpenSci began officially meeting in the fall of 2018. Below
 are the meeting notes from those early meetings.
 
-
-
 ```{toctree}
 ---
 caption: All Meeting Notes
@@ -16,3 +14,10 @@ maxdepth: 1
 2019 Notes <meeting-notes/2019/intro-2019>
 2018 Notes <meeting-notes/2018/intro-2018>
 ```
+
+:::{toctree}
+caption: Executive Council Minutes
+maxdepth: 1
+
+2024 Minutes <meeting-notes/executive-council/2024-executive-council-minutes.md>
+:::

vale-styles/pyos-styles/PyPI.yml

@@ -0,0 +1,28 @@
+extends: substitution
+message: Consider using '%s' instead of '%s'
+level: warning
+ignorecase: false
+action:
+  name: replace
+# swap maps tokens in form of bad: good
+swap:
+  # lower case defined as regex to prevent false positives in URLs or other identifiers
+  - (?:\spypi[\.,]?\s): PyPI
+  - (?:\stestpypi[\.,;:]?\s): TestPyPI
+  - (?:\stest-pypi[\.,;:]?\s): TestPyPI
+  - \bpyopensci\b: pyOpenSci
+  - \bPyOpenSci\b: pyOpenSci
+  # other tests are defined with strings
+  - pyPi: PyPI
+  - pyPI: PyPI
+  - PYPI: PyPI
+  - PyPi: PyPI
+  - Pypi: PyPI
+  - testPyPI: TestPyPI
+  - testPYPI: TestPyPI
+  - TestPypi: TestPyPI
+  - TestPYPI: TestPyPI
+  - back-end: backend
+  - back end: backend
+  - front-end: frontend
+  - front end: frontend