Enhancement/doc-integration

.github/styles/Kedro-viz/Spellings.yml

@@ -0,0 +1,6 @@
+extends: spelling
+message: "Did you really mean '%s'?"
+level: warning
+ignore:
+  - Kedro/ignore.txt
+  - Kedro/ignore-names.txt

.github/styles/Kedro-viz/abbreviations.yml

@@ -0,0 +1,11 @@
+extends: substitution
+message: "Use '%s' instead of abbreviations like '%s'."
+ignorecase: true
+level: warning
+nonword: true
+action:
+  name: replace
+swap:
+  '\b(?:eg|e\.g\.|eg\.)[\s,]': for example
+  '\b(?:ie|i\.e\.|ie\.)[\s,]': that is
+  '\b(?:etc)[\s\n,.]': and more

.github/styles/Kedro-viz/gender.yml

@@ -0,0 +1,13 @@
+extends: existence
+message: "Use a gender-neutral pronoun instead of '%s'."
+level: error
+ignorecase: true
+tokens:
+  - he/she
+  - s/he
+  - \(s\)he
+  - \bhe\b
+  - \bhim\b
+  - \bhis\b
+  - \bshe\b
+  - \bher\b

.github/styles/Kedro-viz/headings.yml

@@ -0,0 +1,56 @@
+extends: capitalization
+message: "'%s' should use sentence-style capitalization."
+level: warning
+scope: heading
+match: $sentence
+exceptions:
+  - Kedro
+  - Kedro-Viz
+  - Airflow
+  - Amazon
+  - Amazon Web Services
+  - AWS Step Functions
+  - AWS Systems Manager
+  - Azure
+  - Azure App Service
+  - Azure App Service Plan
+  - Azure Blob Storage
+  - Azure Event Hub
+  - CI/CD
+  - DataCatalog
+  - Data Catalog
+  - Docker
+  - Docker Compose
+  - Docker Swarm
+  - Dockerfile
+  - GitHub
+  - GitHub Actions
+  - Google
+  - Google Analytics
+  - Google Cloud
+  - Google Cloud Functions
+  - GraphQL
+  - Hook
+  - Hooks
+  - IDs
+  - Jenkins
+  - JFrog
+  - JFrog Artifactory
+  - Jira
+  - Kafka
+  - Kubernetes
+  - Kubernetes Engine
+  - Kubernetes Pod
+  - Kubernetes Service
+  - Lambda
+  - Linux
+  - MySQL
+  - Python
+  - QuantumBlack
+  - QuantumBlack Labs
+  - Red Hat
+  - Redis
+  - Slack
+  - Ubuntu
+  - Unix
+  - URLs

.github/styles/Kedro-viz/ignore-names.txt

@@ -0,0 +1,111 @@
+Ahdra
+Aris
+Alves
+Alam
+Andrew
+Andrii
+Anton
+Antony
+Ankita
+Batori
+Braccialli
+Brummitt
+Cano
+Carvalho
+Cvetanka
+Czakon
+Chan
+Comym
+Couto
+Daiha
+Dada
+Danov
+Datta
+DeBold
+Deepyaman
+Deriabin
+Diaz
+Dmitrii
+Dmitry
+Emamjome
+Erins
+Gabriel
+Gundaniya
+Guilherme
+Hamza
+Hoang
+Holzer
+Huong
+Helmhold
+Ignacio
+Ivaniuk
+Ivan
+Jakub
+Jannic
+Jankowski
+Jitendra
+Jiri
+Jo
+Joel
+Juan
+Kadiri
+Kaiser
+Kaltsas
+Kanchwala
+Katiyar
+Khan
+Kirilenko
+Kiyohito
+Klein
+Kunii
+Kumar
+Lais
+Laura
+Liam
+Lim
+Lorena
+Machado
+Mackay
+Malte
+Malloy
+Marcin
+Meisam
+Merali
+Merel
+Milne
+Nasef
+Nechevska
+Nero
+Nguyen
+Nikolaos
+Nikolic
+Nok
+Okwa
+Oza
+Paricio
+Patel
+Peteris
+Pilla
+Rashida
+Ravi
+Richard
+Schwarzmann
+Sorokin
+Stichbury
+Susanna
+Sajid
+Stephanie
+Takieddine
+Theisen
+Tynan
+Tsaousis
+Valtazanos
+Vladimir
+Waylon
+Westenra
+Wong
+Wrigley
+Yolan
+Yetunde
+Zablocki
+Zain

.github/styles/Kedro-viz/ignore.txt

@@ -0,0 +1,33 @@
+Kedro
+kedro
+Kedro's
+kedro's
+Kubeflow
+Databricks
+Conda
+conda
+Cookiecutter
+config
+fsspec
+Kaggle
+namespace
+namespaces
+namespaced
+regressors
+repo
+Repo
+dbx
+MLflow
+csv
+yaml
+matplotlib
+Matplotlib
+IPython
+APIs
+networkx
+Plotly
+Pylint
+SQLAlchemy
+Astro
+Xebia
+pytest

.github/styles/Kedro-viz/inclusive.yml

@@ -0,0 +1,12 @@
+extends: substitution
+message: "Use '%s' instead of '%s'."
+ignorecase: true
+level: error
+action:
+  name: replace
+swap:
+  # bad: good
+  'black ?list': 'disallow list|exclude list'
+  'master': primary
+  'slave': secondary
+  'white ?list': 'allow list|include list'

.github/styles/Kedro-viz/links.yml

@@ -0,0 +1,12 @@
+extends: substitution
+message: "Use '%s' instead of '%s'."
+ignorecase: true
+level: error
+action:
+  name: replace
+swap:
+  # bad: good
+  'black ?list': 'disallow list|exclude list'
+  'master': primary
+  'slave': secondary
+  'white ?list': 'allow list|include list'

.github/styles/Kedro-viz/oxfordcomma.yml

@@ -0,0 +1,6 @@
+extends: existence
+message: "Use the Oxford comma in '%s'."
+scope: sentence
+level: suggestion
+tokens:
+  - '(?:[^,]+,){1,}\s\w+\s(?:and|or)'

.github/styles/Kedro-viz/pronouns.yml

@@ -0,0 +1,11 @@
+extends: existence
+message: "Avoid first-person singular pronouns such as '%s'."
+level: warning
+nonword: true
+tokens:
+  - (?<=^|\s)I(?=\s)
+  - (?<=^|\s)I,(?=\s)
+  - \bI'm\b
+  - (?<=\s)[Mm]e\b
+  - (?<=\s)[Mm]y\b
+  - (?<=\s)[Mm]ine\b

.github/styles/Kedro-viz/sentencelength.yml

@@ -0,0 +1,11 @@
+extends: occurrence
+message: "Try to keep your sentence length to 30 words or fewer."
+level: suggestion
+# Here, we're counting the number of words
+# in a sentence.
+#
+# If there are more than 30, we'll flag it.
+scope: sentence
+ignorecase: false
+max: 30
+token: (\w+)