Move sysl-website content into sysl/docs (#367)

.github/workflows/docs.yml

@@ -0,0 +1,13 @@
+name: Check docs
+
+on: [pull_request]
+
+jobs:
+  markdown-link-check:
+    name: Check for broken links
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        folder-path: 'docs'

Makefile

@@ -17,6 +17,7 @@ all: lint build buildlsp install test coverage
 
 lint: generate
 	golangci-lint run ./...
+	make -C docs lint
 
 lint-docker: generate
 	docker run --rm \
@@ -33,6 +34,7 @@ tidy:
 	go mod tidy
 	gofmt -s -w .
 	goimports -w .
+	make -C docs tidy
 
 # Generates intermediate files for build.
 generate: internal/arrai/bindata.go

docs/.gitignore

@@ -0,0 +1,24 @@
+# Dependencies
+node_modules/
+
+# Production
+build/
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Spellcheck Files
+dictionary.dic
+package-lock.json

docs/.prettierignore

@@ -0,0 +1,24 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Spellcheck Files
+dictionary.dic
+

docs/.prettierrc.json

@@ -0,0 +1 @@
+{}

docs/.spellcheck.yml

@@ -0,0 +1,21 @@
+matrix:
+  - name: Markdown
+    aspell:
+      lang: en
+    dictionary:
+      wordlists:
+        - .wordlist.txt
+      encoding: utf-8
+    pipeline:
+      - pyspelling.filters.markdown:
+      - pyspelling.filters.html:
+        comments: false
+        ignores:
+          - code
+          - pre
+    sources:
+      # - 'blog/*.md'
+      - "docs/*.md"
+      - "examples/*.md"
+      - "*.md"
+    default_encoding: utf-8

docs/.wordlist.txt

@@ -0,0 +1,267 @@
+AccountTransactionApi
+Algolia
+amd
+AnotherApp
+ANZ
+anz
+anzbank
+api
+APIs
+ApP
+App
+aPP
+appfmt
+ApplicationPackage
+appname
+args
+aspell
+attr
+attrDefs
+attrib
+attrib's
+attribs
+attrs
+AUTOGENERATED
+backend
+BankDatabase
+basepath
+bashrc
+bff
+BizApp
+BLACKBOX
+blackbox
+blackboxes
+bodyParam
+bool
+byexample
+CardInfo
+ccf
+cd
+classname
+CLI
+cmd
+codegen
+colNumber
+complexType
+config
+CreditCard
+css
+CustomerOrder
+CustomerOrderModel
+darwin
+DataBase
+datadiagram
+datamodel
+datatypes
+datetime
+dbscriptdelta
+dbscripts
+dcx
+defs
+dep
+deps
+dev
+DevOps
+diagramgen
+dir
+disableLiveReload
+Dockerfile
+DocSearch
+docsearch
+Docusaurus
+docusaurus
+ee
+EmailNotifier
+endpointanalysis
+enum
+env
+epa
+epfmt
+eplongname
+epname
+extensibility
+faq
+fb
+fileName
+filepath
+filewatchers
+fka
+fmt
+frontend
+GetAccount
+GetBalance
+GetGreeting
+github
+GOARCH
+goimports
+Golang
+GoldMark
+GOOS
+GroceryStore
+grocerystore
+GROUPBY
+groupby
+gRPC
+grpc
+HandleFormSubmit
+HelloProject
+HelloService
+HelloWorld
+homebrew
+href
+html
+http
+https
+IdentityProvider
+imageDest
+img
+init
+integrationdiagram
+integrations
+ints
+io
+js
+json
+jsx
+lang
+launchctl
+lineNumber
+linkcheck
+Linter
+linter
+linux
+localhost
+LoginData
+LoginResponse
+LongName
+longName
+macOS
+maxfiles
+maxOccurs
+md
+MegaDatabase
+MegaDatabase
+MermaidJS
+minOccurs
+MobileApp
+myQueryParam
+namespaced
+Namespaces
+Netlify
+noCSS
+noImages
+nondev
+NotMySystem
+npm
+ok
+omni
+OpenAPI
+openapi
+OrderData
+oss
+outdir
+OutputDir
+outputFileName
+PaymentInfo
+PaymentProvider
+PaymentService
+pb
+PLANTUML
+PlantUML
+plantuml
+png
+postfix
+postgres
+pre
+proto
+protobuf
+protobufs
+protoc
+prototext
+puml
+PWD
+pwd
+pyspell
+queryParamName
+QueryParamType
+QueryTransactions
+README
+redefinitions
+ReDoc
+redoc
+RegisterEvent
+reljam
+REPL
+repl
+repo
+ReST
+ro
+roadmap
+RPC
+Runtime
+schemas
+sd
+seqtitle
+sequencediagram
+SimpleObj
+SimpleOpenAPI
+SimpleSwagger
+SmsNotifier
+SomePrimitiveType
+sourceContext
+src
+StackOverflow
+stdout
+stmt
+sudo
+SVG
+svg
+SVGs
+svgs
+Sysl
+sysl
+Sysl's
+sysl's
+templated
+textpb
+ThisAppShouldntShow
+ThisAppShouldShow
+tmpl
+TODO
+tooManyAttempts
+txt
+UI
+ui
+ulimit
+UML
+uml
+Uncompress
+url
+URL's
+urlencoder
+useBaseUrl
+userID
+userId
+userIduserId
+UserPreference
+UserService
+usr
+validator
+vscode
+WIP
+WithdrawFunds
+wordlist
+www
+xml
+xmlns
+XMLSchema
+xs
+XSD
+xsd
+YAML
+yaml
+zshrc
+TypeInt
+TypeString
+TypeUUID
+UnionType

docs/AUTHORS.yml

@@ -15,9 +15,9 @@
 #       www: personal website (optional)
 
 authors:
-- name: Australia and New Zealand Banking Group Limited
-  short-name: ANZ
-  email: [email protected]
-  www: anz.com
-- name: Oliver Lade
-  email: [email protected]
+  - name: Australia and New Zealand Banking Group Limited
+    short-name: ANZ
+    email: [email protected]
+    www: anz.com
+  - name: Oliver Lade
+    email: [email protected]

docs/CONTRIBUTING.md

@@ -29,7 +29,6 @@ Prerequisites:
 - `protoc-gen-go`: `go get github.com/golang/protobuf/protoc-gen-go`
 - `go-bindata`: `go get github.com/anz-bank/go-bindata/...`
 
-
 Clone `sysl` to create a local copy on your computer:
 
 ```sh