add Vale rules

docs/docs-next/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+    extends: ['@dagster-io/eslint-config', 'plugin:@docusaurus/recommended'],
+    rules: {
+        'import/no-default-export': 'off',
+        'react/react-in-jsx-scope': 'off',
+    },
+};

docs/docs-next/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  bracketSpacing: false,
+  printWidth: 100,
+  singleQuote: true,
+  trailingComma: 'all',
+};

docs/docs-next/.remarkrc.js

@@ -0,0 +1,13 @@
+exports.settings = {
+  bullet: "-",
+  emphasis: "_",
+  strong: "*",
+  listItemIndent: "one",
+  rule: "-",
+};
+exports.plugins = [
+  require("remark-frontmatter"),
+  require("remark-preset-prettier"),
+  // GitHub Flavored Markdown's table pipe alignment
+  [require("remark-gfm"), { tablePipeAlign: true }],
+];

docs/docs-next/.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-}
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}

docs/docs-next/package.json

@@ -38,7 +38,8 @@
     "@docusaurus/types": "3.5.2",
     "@eslint/js": "^9.9.0",
     "@typescript-eslint/parser": "^8.0.1",
-    "eslint": "^9.9.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-mdx": "^3.1.5",
     "eslint-plugin-react": "^7.35.0",
     "globals": "^15.9.0",
     "prettier": "^3.3.3",

docs/vale/styles/Dagster/british.yml

@@ -0,0 +1,114 @@
+extends: substitution
+message: "Use the US spelling '%s' instead of the British '%s'."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language
+level: error
+ignorecase: true
+swap:
+  aeon: eon
+  aeroplane: airplane
+  ageing: aging
+  aluminium: aluminum
+  anaemia: anemia
+  anaesthesia: anesthesia
+  analyse: analyze
+  annexe: annex
+  apologise: apologize
+  authorise: authorize
+  authorised: authorized
+  authorisation: authorization
+  authorising: authorizing
+  behaviour: behavior
+  busses: buses
+  calibre: caliber
+  categorise: categorize
+  categorised: categorized
+  categorises: categorizes
+  categorising: categorizing
+  centre: center
+  cheque: check
+  civilisation: civilization
+  civilise: civilize
+  colour: color
+  cosy: cozy
+  cypher: cipher
+  dependant: dependent
+  defence: defense
+  distil: distill
+  draught: draft
+  encyclopaedia: encyclopedia
+  enquiry: inquiry
+  enrol: enroll
+  enrolment: enrollment
+  enthral: enthrall
+  # equalled: equaled // Under discussion
+  # equalling: equaling // Under discussion
+  favourite: favorite
+  fibre: fiber
+  fillet: filet
+  flavour: flavor
+  furore: furor
+  fulfil: fulfill
+  gaol: jail
+  grey: gray
+  humour: humor
+  honour: honor
+  initialled: initialed
+  initialling: initialing
+  instil: instill
+  jewellery: jewelry
+  labelling: labeling
+  labelled: labeled
+  labour: labor
+  libellous: libelous
+  licence: license
+  likeable: likable
+  liveable: livable
+  lustre: luster
+  manoeuvre: maneuver
+  marvellous: marvelous
+  matt: matte
+  meagre: meager
+  metre: meter
+  modelling: modeling
+  moustache: mustache
+  neighbour: neighbor
+  normalise: normalize
+  offence: offense
+  optimise: optimize
+  optimised: optimized
+  optimising: optimizing
+  organise: organize
+  orientated: oriented
+  paralyse: paralyze
+  plough: plow
+  pretence: pretense
+  programme: program
+  pyjamas: pajamas
+  rateable: ratable
+  realise: realize
+  recognise: recognize
+  reconnoitre: reconnoiter
+  rumour: rumor
+  sabre: saber
+  saleable: salable
+  saltpetre: saltpeter
+  sceptic: skeptic
+  sepulchre: sepulcher
+  signalling: signaling
+  sizeable: sizable
+  skilful: skillful
+  sombre: somber
+  smoulder: smolder
+  speciality: specialty
+  spectre: specter
+  splendour: splendor
+  standardise: standardize
+  standardised: standardized
+  sulphur: sulfur
+  theatre: theater
+  travelled: traveled
+  traveller: traveler
+  travelling: traveling
+  unshakeable: unshakable
+  wilful: willful
+  yoghurt: yogurt

docs/vale/styles/Dagster/eol-whitespace.yml

@@ -0,0 +1,8 @@
+---
+extends: existence
+message: "Remove whitespace characters from the end of the line."
+link: https://docs.gitlab.com/ee/development/documentation/versions.html
+level: warning
+scope: raw
+raw:
+  - ' +\n'

docs/vale/styles/Dagster/heading-content.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "Rename the heading '%s', or re-purpose the content elsewhere."
+level: warning
+link: https://docs.gitlab.com/ee/development/documentation/topic_types/concept.html#concept-topic-titles
+ignorecase: true
+nonword: true
+scope: raw
+tokens:
+  - '\#+ How it works'
+  - '\#+ Overview'

docs/vale/styles/Dagster/latin-terms.yml

@@ -0,0 +1,10 @@
+extends: substitution
+message: "Use '%s' instead of '%s', but consider rewriting the sentence."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+level: warning
+nonword: true
+ignorecase: true
+swap:
+  '\b(?:e\.?g[\s.,;:])': for example
+  '\b(?:i\.?e[\s.,;:])': that is
+  '\bvia\b': "with', 'through', or 'by using"

docs/vale/styles/Dagster/non-standard-quotes.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: "Use standard single quotes or double quotes only. Do not use left or right quotes."
+level: warning
+ignorecase: true
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation
+scope: raw
+raw:
+  - '[‘’“”]'

docs/vale/styles/Dagster/wordy.yml

@@ -0,0 +1,15 @@
+extends: substitution
+message: "%s"
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+level: suggestion
+ignorecase: true
+swap:
+  a number of: "Specify the number or remove the phrase."
+  as well as: "Use 'and' instead of 'as well as'."
+  note that: "Remove the phrase 'note that'."
+  please: "Use 'please' only if we've inconvenienced the user."
+  respectively: "Remove 'respectively' and list each option instead."
+  and so on: "Remove 'and so on'. Try to use 'like' and provide examples instead."
+  in order to: "Remove 'in order' and leave 'to'."
+  quite: "Remove 'quite', as it's wordy."
+