From 0f088437a7c9a1600a20eeb42050618dff39a521 Mon Sep 17 00:00:00 2001 From: Dylan Arbour Date: Mon, 21 Mar 2022 16:49:55 -0400 Subject: [PATCH 01/10] Create spellcheck.yml --- .github/workflows/spellcheck.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/workflows/spellcheck.yml diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 000000000..02c5ae454 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,15 @@ +name: documentation + +on: + pull_request: + branches: main + push: + branches: main + +jobs: + spellcheck: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - uses: igsekor/pyspelling-any@v1.0.4 From adbbc9778ca5a89eabd507a8995db79308390bfb Mon Sep 17 00:00:00 2001 From: Dylan Arbour Date: Mon, 21 Mar 2022 16:56:55 -0400 Subject: [PATCH 02/10] Add spellcheck configuration --- .spellcheck.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .spellcheck.yaml diff --git a/.spellcheck.yaml b/.spellcheck.yaml new file mode 100644 index 000000000..72e7d5e49 --- /dev/null +++ b/.spellcheck.yaml @@ -0,0 +1,8 @@ +matrix: + - name: markdown + sources: + - website/docs/**/*.md + aspell: + H: true + # pipeline: + # - pyspelling.filters.html From 912f92dc3924e050d4c02df3525c0a5a88907009 Mon Sep 17 00:00:00 2001 From: Dylan Arbour Date: Mon, 21 Mar 2022 17:25:57 -0400 Subject: [PATCH 03/10] Add allowlist --- spelling.dic | 519 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 519 insertions(+) create mode 100644 spelling.dic diff --git a/spelling.dic b/spelling.dic new file mode 100644 index 000000000..097dade09 --- /dev/null +++ b/spelling.dic @@ -0,0 +1,519 @@ +0s +1s +acmeco +ActiveX +AddGroup +adminUri +Afterware +allowHTTP +allowIPs +allowPrivate +apache +api +apiGroup +APIs +apiVersion +args +Args +arrayBuffer +asm +assemblyscript +AssertHeaders +AssertJSON +AssertStatus +async +atmo +Atmo +ATMO +Atmo's +atmoVersion +Auth +Autoscale +autoscaler +autoscaling +Autoscaling +awesomeco +backend +badRunner +behaviour +blockedDomains +bodyBytes +bodyField +bool +brokerAddress +BTreeMap +BuilderTemplate +builderUri +BuildFunctionString +BUILDKIT +bytecode +CacheGet +CacheSet +callsite +cd +cern +CERN +ChangeEvent +CLI +cohix +composable +Compute's +config +Config +connectionString +connor +const +constd +ContentTypeMiddleware +controlplane +CORS +CPUs +createdResponse +CreateUser +createWordcountMiddleware +css +ctx +Ctx +ctype +customizable +customizations +deallocated +declaratively +defence +denyMiddleware +deployable +deployDraft +desiredmessage +dev +devgenius +dir +Distroless +DNS +doBad +Dockerfile +doExpensive +doGeneric +doMath +doTimeout +doWasm +draftVersion +ENTRYPOINT +env +ENV +errgroup +ErrJobTimeout +ErrMsgNotWanted +ErrorResponse +ErrorString +ErrWaitTimeout +ExecString +execUri +expensiveRunnable +extensibility +extern +facto +fas +fdd +fermyon +FFI +Files in repository contain spelling errors +filesystem +filesystems +FirstProposalMarch +fmt +fn +Fn +fnName +fqfn +FQFN +fqfnURI +FullColour +func +functionList +Gav +getBytes +getDraft +getFunctionErrors +getFunctionResults +getFunctions +getstarted +getStatic +getStaticBytes +GetStaticFile +getTemplate +gettingStarted +getToken +getUsers +GggP +ghstars +github +githubusercontent +gitlab +GitLab +golang +GOPATH +goroutine +graphql +graphQL +GraphQL +graphQLQuery +grav +Grav +Grav's +groupId +grp +HandleBundle +HandleCreate +HandleCreateGroup +HandleDelete +HandleEventsV +HandleGetEvents +HandleGetUsers +HandleHTTP +HandleMsg +HandlePing +handlePost +HandlerFunc +headerMiddleware +headerType +helloworld +Homebrew +hostname +hostnames +html +http +Http +httpDelete +HttpDelete +httpget +httpGet +HttpGet +httpPatch +HttpPatch +httpPost +HttpPost +HttpResponse +httprouter +https +HTTPS +ident +Ident +iframe +img +impl +importantmessage +indexHtml +init +inital +InsertUser +inStr +integrations +io +IoT +ioutil +JavaBeans +javascript +jpg +js +json +JSON +jsonBytesFromJSONMarshal +jsx +julienschmidt +kafka +Kármán +KEDA +kubectl +kubernetes +Kubernetes +lang +lastInsertID +lbF +learnings +len +LetsEncrypt +listAvailableFunctions +LoadBalancer +localConfig +LocalConfig +localhost +logAfter +logDebug +logErr +loginEmailRunner +LogInfo +logme +LogWarn +LookupEnv +lS +macOS +mailto +MarshalJSON +marshalled +MaxRetries +md +MethodPost +microsoft +middleware +Middleware +mkdir +mlc +mozilla +msg +msgFunc +MsgReceipt +MsgTypeDefault +msgTypeLogin +multicast +MultiLanguageCodeBlock +mut +myfunction +myjavascriptfunction +mysql +namespace +Namespace +namespaces +natively +nats +NATS +networkRules +NewClient +NewGroup +NewJob +NewMsg +NewReader +NewRequest +NewRunnable +NewRunner +NewWCResponse +NeXT +nodejs +NodeUUID +npm +ok +Ok +OnChange +onErr +OnReply +OnType +OptionsModifier +OptionsModifiers +os +OutputLog +param +parametrized +params +Params +particulary +pdf +performant +plaintext +png +PoolSize +postgresql +pre +Pre +prev +PreWarm +Println +programmatically +PromoteDraft +ps +pwd +QueryArg +quickstart +reactr +Reactr +Reactr's +ReadAll +readme +README +reccomended +receiveMessagesAsync +receiveMessagesSync +reciepts +Reciepts +recieve +recurse +redis +REPL +ReplyTo +repo +REPO +req +Req +reqBody +reqBodyField +ReqBodyField +ReqBodyRaw +reqHeader +ReqHeader +reqID +ReqID +reqInfo +reqMethod +ReqMethod +ReqParam +reqState +ReqState +Requestid +RequestID +requestReply +reqURL +ReqURL +reqURLParam +RespHeaders +respondTo +RetrySeconds +rocketship +rowsAffected +RPC +runerr +RunErr +runFunction +runnable +Runnable +RUNNABLE +runnable's +Runnable's +runnables +Runnables +runtime +Runtime +RVG +rwasm +SaaS +sandboxed +scalable +scc +SCC +SCHED +SDK +SelectUserWithUUID +sendMessages +serverAddress +serverless +SetHeader +setupServer +signup +someStructInstance +Sooooobo +specialmessage +Sprintf +sql +src +starman +stateBytes +StatusApplicationError +StatusConflict +StatusCreated +StatusForbidden +StatusOK +stdin +stdout +str +struct +subo +Subo +subtest +subtests +successfuly +SUFA +svc +svg +SwiftWasm +TabItem +tentpoles +testdata +testDraft +TestWordcount +ThenDo +ThenInt +TheProject +timeoutRunner +TimeoutSeconds +tinygo +tls +TLS +tmpl +toolchain +toolchains +topologies +tpjno +ttl +TTL +TypeScript +UI +Uint +un +UpdateUserWithUUID +uri +URI +url +urlParam +UseAppName +UseDiscovery +UseDomain +UseEndpoint +UseEnvPrefix +useGravInstance +UseHTTPPort +UseLogger +UseRequestID +userid +userId +UseScope +UseTLSConfig +UseTLSPort +UseTransport +utf +UTF +util +uuid +Uuid +UUID +varCount +vec +Vec +vektor +Vektor +Vektor's +vk +VK +vk's +vlog +vt +vtest +VTest +WaitOn +WaitUntil +wasi +WASI +wasm +Wasm +Wasmer +wasmrunnable +wasmtime +Wasmtime +wc +WCResponse +webassembly +WebAssembly +WebAssembly's +webpage +webserver +websocket +Websocket +websockets +wordcount +Wordcount +wordcountCtxKey +workerRunner +Workspaces +wsl +WSL +www +XCode +xcrun +yaml +yml From 16a8fe8ece19849787d3059544f04b7d308ef94c Mon Sep 17 00:00:00 2001 From: Dylan Arbour Date: Mon, 21 Mar 2022 17:27:45 -0400 Subject: [PATCH 04/10] Add markdown filter --- .github/workflows/spellcheck.yml | 8 +++++--- .spellcheck.yaml | 4 ++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index 02c5ae454..89e9bd529 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -2,14 +2,16 @@ name: documentation on: pull_request: - branches: main + branches: + - main push: - branches: main + branches: + - main jobs: spellcheck: runs-on: ubuntu-latest - + steps: - uses: actions/checkout@v3 - uses: igsekor/pyspelling-any@v1.0.4 diff --git a/.spellcheck.yaml b/.spellcheck.yaml index 72e7d5e49..9f9525cc2 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -4,5 +4,5 @@ matrix: - website/docs/**/*.md aspell: H: true - # pipeline: - # - pyspelling.filters.html + pipeline: + - pyspelling.filters.markdown: From 133cea11fe5d41794ada478a69c678ee0ffdb365 Mon Sep 17 00:00:00 2001 From: Laura Langdon <48335772+LauraLangdon@users.noreply.github.com> Date: Tue, 26 Apr 2022 18:11:33 -0700 Subject: [PATCH 05/10] docs: fix capitalization --- .../install-compute-in-your-cloud-environment.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/docs/compute/cloud-deployment/install-compute-in-your-cloud-environment.md b/website/docs/compute/cloud-deployment/install-compute-in-your-cloud-environment.md index 8da5015f8..554ce3273 100755 --- a/website/docs/compute/cloud-deployment/install-compute-in-your-cloud-environment.md +++ b/website/docs/compute/cloud-deployment/install-compute-in-your-cloud-environment.md @@ -3,7 +3,8 @@ To install Compute in the cloud, you'll use the `subo` tool to automatically install the Suborbital Compute Core into a Kubernetes cluster. You need to ensure you have some **pre-requisites** ready: 1. Deploy a Kubernetes cluster into your cloud provider of choice (if you have a pre-existing one, that works too!). - * [Ensure there is a storage class available in kubernetes](https://kubernetes.io/docs/concepts/storage/storage-classes/). Some cloud providers such as AWS do not have a default storage class. See this great [GitLab guide on how to set up a storage class](https://docs.gitlab.com/charts/installation/storage.html#configuring-cluster-storage). + * [Ensure there is a storage class available in Kubernetes] + * (https://kubernetes.io/docs/concepts/storage/storage-classes/). Some cloud providers such as AWS do not have a default storage class. See this great [GitLab guide on how to set up a storage class](https://docs.gitlab.com/charts/installation/storage.html#configuring-cluster-storage). * If you would like assistance with storage, [send us an email](mailto:team@suborbital.dev)! 2. [Install the `kubectl` tool](https://kubernetes.io/docs/tasks/tools/#kubectl) and authenticate it with the cluster you want to use. 3. Ensure you have access to modify your company's DNS records, as you need to create a domain name for the builder service (it must run on HTTPS, which requires a domain) From 3e21792fd1ae8697f0fb202d6c7a82afc8c37b33 Mon Sep 17 00:00:00 2001 From: Laura Langdon <48335772+LauraLangdon@users.noreply.github.com> Date: Tue, 26 Apr 2022 18:12:15 -0700 Subject: [PATCH 06/10] feat: add spelling.dic for spellcheck --- spelling.dic | 9 --------- 1 file changed, 9 deletions(-) diff --git a/spelling.dic b/spelling.dic index 097dade09..d3b560140 100644 --- a/spelling.dic +++ b/spelling.dic @@ -1,6 +1,5 @@ 0s 1s -acmeco ActiveX AddGroup adminUri @@ -24,7 +23,6 @@ AssertStatus async atmo Atmo -ATMO Atmo's atmoVersion Auth @@ -32,7 +30,6 @@ Autoscale autoscaler autoscaling Autoscaling -awesomeco backend badRunner behaviour @@ -204,7 +201,6 @@ impl importantmessage indexHtml init -inital InsertUser inStr integrations @@ -304,7 +300,6 @@ param parametrized params Params -particulary pdf performant plaintext @@ -328,12 +323,8 @@ Reactr's ReadAll readme README -reccomended receiveMessagesAsync receiveMessagesSync -reciepts -Reciepts -recieve recurse redis REPL From 9dcd4edb7d65d39a07c6f32f0b851f6e1748424e Mon Sep 17 00:00:00 2001 From: Laura Langdon Date: Wed, 27 Apr 2022 08:54:26 -0700 Subject: [PATCH 07/10] fix: add spelling.dic to spelling.yml --- .spellcheck.yaml | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/.spellcheck.yaml b/.spellcheck.yaml index 9f9525cc2..563bdb8fc 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -3,6 +3,14 @@ matrix: sources: - website/docs/**/*.md aspell: - H: true + lang: en + dictionary: + wordlists: + - spelling.dic pipeline: - pyspelling.filters.markdown: + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre From 39eef5cc00e6dec71d7335c4fde1cb298099eef8 Mon Sep 17 00:00:00 2001 From: Laura Langdon Date: Wed, 27 Apr 2022 09:01:28 -0700 Subject: [PATCH 08/10] fix: matching spelling.yml to example Previous build failed `spellcheck.yml` test, citing `expected , but found '?' in "", line 7, column 3: dictionary: ^` Just trying matching our `spellcheck.yml` to the example: https://github.com/igsekor/pyspelling-any/blob/main/spellcheck.yaml to see if that fixes it. --- .spellcheck.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.spellcheck.yaml b/.spellcheck.yaml index 563bdb8fc..97390c39b 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -1,7 +1,8 @@ matrix: - - name: markdown + - name: Markdown sources: - - website/docs/**/*.md + - 'website/docs/**/*.md' + default_encoding: utf-8 aspell: lang: en dictionary: From 46db0509742f6ed88af35618d2d905fc8a40aabf Mon Sep 17 00:00:00 2001 From: Laura Langdon Date: Wed, 27 Apr 2022 10:14:41 -0700 Subject: [PATCH 09/10] fix: move code to spelling.yml Moved code from `docs/.spellcheck.yaml` (don't even know where that came from?) to `docs/.github/workflows/spellcheck.yml` --- .github/workflows/spellcheck.yml | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index 89e9bd529..e51e27b70 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -1,4 +1,4 @@ -name: documentation +name: spellcheck on: pull_request: @@ -11,7 +11,24 @@ on: jobs: spellcheck: runs-on: ubuntu-latest - steps: - uses: actions/checkout@v3 - uses: igsekor/pyspelling-any@v1.0.4 + + matrix: + - name: Markdown + sources: + - 'website/docs/**/*.md' + default_encoding: utf-8 + aspell: + lang: en + dictionary: + wordlists: + - spelling.dic + pipeline: + - pyspelling.filters.markdown: + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre From f4f8bd018f9232bd6d50efc7a9ba9439458b1b53 Mon Sep 17 00:00:00 2001 From: Laura Langdon Date: Wed, 27 Apr 2022 10:15:37 -0700 Subject: [PATCH 10/10] Delete .spellcheck.yaml This shouldn't be here, I think; it should be .`github/workflows/spellcheck.yml`. --- .spellcheck.yaml | 17 ----------------- 1 file changed, 17 deletions(-) delete mode 100644 .spellcheck.yaml diff --git a/.spellcheck.yaml b/.spellcheck.yaml deleted file mode 100644 index 97390c39b..000000000 --- a/.spellcheck.yaml +++ /dev/null @@ -1,17 +0,0 @@ -matrix: - - name: Markdown - sources: - - 'website/docs/**/*.md' - default_encoding: utf-8 - aspell: - lang: en - dictionary: - wordlists: - - spelling.dic - pipeline: - - pyspelling.filters.markdown: - - pyspelling.filters.html: - comments: false - ignores: - - code - - pre