diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 000000000..e51e27b70 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,34 @@ +name: spellcheck + +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 + + 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 diff --git a/spelling.dic b/spelling.dic new file mode 100644 index 000000000..d3b560140 --- /dev/null +++ b/spelling.dic @@ -0,0 +1,510 @@ +0s +1s +ActiveX +AddGroup +adminUri +Afterware +allowHTTP +allowIPs +allowPrivate +apache +api +apiGroup +APIs +apiVersion +args +Args +arrayBuffer +asm +assemblyscript +AssertHeaders +AssertJSON +AssertStatus +async +atmo +Atmo +Atmo's +atmoVersion +Auth +Autoscale +autoscaler +autoscaling +Autoscaling +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 +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 +pdf +performant +plaintext +png +PoolSize +postgresql +pre +Pre +prev +PreWarm +Println +programmatically +PromoteDraft +ps +pwd +QueryArg +quickstart +reactr +Reactr +Reactr's +ReadAll +readme +README +receiveMessagesAsync +receiveMessagesSync +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 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)