forked from Redocly/redoc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/Redocly/redoc into Redocly-…
…main
- Loading branch information
Showing
76 changed files
with
7,697 additions
and
6,734 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| extends: substitution | ||
| message: 'Use the US spelling "%s" instead of British "%s".' | ||
| link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words | ||
| level: error | ||
| ignorecase: true | ||
| swap: | ||
| aeon: eon | ||
| aeroplane: airplane | ||
| ageing: aging | ||
| aluminium: aluminum | ||
| anaemia: anemia | ||
| anaesthesia: anesthesia | ||
| analyse: analyze | ||
| annexe: annex | ||
| apologise: apologize | ||
| behaviour: behavior | ||
| busses: buses | ||
| calibre: caliber | ||
| cancelled: canceled | ||
| cancellation: cancelation | ||
| catalogue: catalog | ||
| 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 | ||
| expiry: expiration | ||
| 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 | ||
| organise: organize | ||
| organisation: organization | ||
| 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| extends: existence | ||
| message: 'Avoid using future tense: "%s". Use present tense instead.' | ||
| link: https://intranet.redoc.ly/contributing/documentation-style-guide/#tone-and-audience | ||
| ignorecase: true | ||
| level: error | ||
| raw: | ||
| - "(going to( |\n|[[:punct:]])[a-zA-Z]*|" | ||
| - "will( |\n|[[:punct:]])[a-zA-Z]*|" | ||
| - "won't( |\n|[[:punct:]])[a-zA-Z]*|" | ||
| - "[a-zA-Z]*'ll( |\n|[[:punct:]])[a-zA-Z]*)" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| extends: existence | ||
| message: 'Do not start headings with with a gerund (ing word). Use an imperative verb instead.' | ||
| link: https://intranet.redoc.ly/contributing/documentation-style-guide/#content-organization | ||
| level: error | ||
| scope: heading | ||
| tokens: | ||
| - '^\w*ing.*' | ||
| exceptions: | ||
| - expandSingleSchemaField | ||
| - hideLoading | ||
| - hideSingleRequestSampleTab |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| extends: substitution | ||
| message: 'Use inclusive language. Consider "%s" instead of "%s".' | ||
| link: https://intranet.redoc.ly/contributing/documentation-style-guide/#grammar-and-syntax | ||
| level: error | ||
| ignorecase: true | ||
| swap: | ||
| he: they | ||
| his: their | ||
| she: they | ||
| hers: their | ||
| blacklist(?:ed|ing|s)?: blocklist | ||
| whitelist(?:ed|ing|s)?: allowlist | ||
| master: primary, main | ||
| slave: replica | ||
| he/she: they | ||
| s/he: they |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| extends: existence | ||
| message: "Use the Oxford comma in '%s'." | ||
| link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas | ||
| scope: sentence | ||
| level: error | ||
| nonword: true | ||
| tokens: | ||
| - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| [Aa]nsible | ||
| [Aa]utostart | ||
| [Bb]locklist | ||
| [Bb]locklists | ||
| [Bb]oolean | ||
| [Bb]reakpoint | ||
| [B]reakpoints | ||
| [Cc]ancelation | ||
| [Cc]lassloading | ||
| [Cc]hargeback | ||
| [Cc]hargebacks | ||
| [Cc]he | ||
| [Cc]rypto | ||
| [Cc]ryptocurrency | ||
| [Dd]evfile|[Dd]evfiles | ||
| [Dd]ownstream | ||
| [Dd]ownstreaming | ||
| [Ff]actories|[Ff]actory | ||
| [Gg]it | ||
| [Gg]rafana | ||
| [Hh]eatmap | ||
| [Hh]elm | ||
| [Hh]ostname | ||
| [Ii]tem | ||
| [Jj]etbrains | ||
| [Kk]eycloak | ||
| [Ll]iveness | ||
| [Ll]ombok | ||
| [Ll]oopback | ||
| [Mm]aven | ||
| [Mm]inikube | ||
| [Mm]inishift | ||
| [Mm]ixin|[Mm]ixins | ||
| [Mm]odularization | ||
| [Mm]ulticluster | ||
| [Mm]ultihost | ||
| [Mm]ultinode | ||
| [Mm]ultitenant | ||
| [Mm]ultiuser | ||
| [Mm]ultizone | ||
| [Nn]amespace|[Nn]amespaces | ||
| [Nn]etcoredebug[Oo]utput | ||
| [Nn]ginx | ||
| [Oo]nboarding | ||
| [Pp]podman | ||
| [Pp]reconfigured | ||
| [Rr]eadonly | ||
| [Rr]epresentment | ||
| [Rr]ollout|[Rr]ollouts | ||
| [Rr]untime|[Rr]untimes | ||
| [Ss]erializer | ||
| [Ss]erverless | ||
| [Ss]ubnetwork | ||
| [Ss]ubpath|[Ss]ubpaths | ||
| [Tt]heia | ||
| [Tt]olerations | ||
| [Tt]ruststore | ||
| [Uu]ninstallation | ||
| [Uu]nstaged | ||
| [Uu]ntrusted | ||
| [Ww]orkspace|[Ww]orkspaces | ||
| [Yy]eoman | ||
| \.NET | ||
| adoc | ||
| Antora | ||
| API | ||
| Apigee | ||
| AsciiDoc | ||
| AWS|aws | ||
| Azure | ||
| Bierner | ||
| Bitbucket | ||
| btn | ||
| Btrfs | ||
| CentOS | ||
| Ceph | ||
| Che-Theia | ||
| CLI | ||
| ConfigMap|ConfigMaps | ||
| Ctrl | ||
| DaemonSet | ||
| Dev Workspace | ||
| Developer Perspective | ||
| DNS | ||
| Docker | ||
| Dockerfile | ||
| Dotnet | ||
| Endevor | ||
| endif | ||
| GitHub|github | ||
| GitLab | ||
| Gluster | ||
| Gradle | ||
| Grafana | ||
| GUI | ||
| HTTPS|https | ||
| I/O | ||
| IDE|ide|IDEs | ||
| Intelephense | ||
| IntelliJ IDEA | ||
| Java | ||
| Java Lombok | ||
| JSON|json | ||
| JVM|jvm | ||
| kbd | ||
| Kubespray | ||
| Laravel | ||
| Let\'s Encrypt | ||
| Mattermost | ||
| mebibytes | ||
| Microsoft Azure | ||
| millicores | ||
| Mulesoft | ||
| MySQL | ||
| Netlify | ||
| Node.js | ||
| npm | ||
| NuGet | ||
| OAuth | ||
| ocp | ||
| OmniSharp | ||
| OpenShift | ||
| OpenTracing | ||
| Operator | ||
| OperatorHub | ||
| OpenAPI | ||
| osd | ||
| PHP | ||
| PostgreSQL | ||
| Quarkus | ||
| Rebilly | ||
| Redoc | ||
| Redocly | ||
| Redocly-cli | ||
| SCM | ||
| Sharding | ||
| SonarLint | ||
| Spring Boot | ||
| SVG | ||
| Uber | ||
| URI|URIs | ||
| URL|url|URLs | ||
| Velero | ||
| Vercel | ||
| Visual Studio Code | ||
| vsix | ||
| Webview|Webviews | ||
| Woopra | ||
| YAML|yaml | ||
| Zowe |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| name: Docs lint | ||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened] | ||
|
|
||
| jobs: | ||
| vale: | ||
| name: vale action | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: errata-ai/vale-action@reviewdog | ||
| with: | ||
| files: '["README.md", "docs"]' | ||
| env: | ||
| GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} |
Oops, something went wrong.