Documentation (MKDOCS) (#1230)

Co-authored-by: Steve Richards <srichards@mirantis.com>
Co-authored-by: Mario Sarcher <msarcher@mirantis.com>
Co-authored-by: steve richards <steve.james.richards@gmail.com>
Co-authored-by: Paul Williams <pawilliams@mirantis.com>
Co-authored-by: pauljwil <pauljwil@gmail.com>
This commit is contained in:
authored and GitHub committed 2020-11-05 16:38:56 +02:00
1 parent d074e0499f
commit 3bc45218c1
41 files changed
+719 -2

No files matched your search

+12
View File
@@ -45,6 +45,16 @@ Allows for faster separate re-runs of some of the more involved processes:
1. `yarn dev:extension-types` compile declaration types for `@k8slens/extensions`
1. `yarn dev-run` runs app in dev-mode and auto-restart when main process file has changed
## Development (documentation)
Run a local instance of `mkdocs serve` in a docker container for developing the Lens Documentation.
> Prerequisites: docker, yarn
* `yarn mkdocs-serve-local` - local build and serve of mkdocs with auto update enabled
Go to [localhost:8000](http://127.0.0.1:8000)
## Developer's ~~RTFM~~ recommended list:
- [TypeScript](https://www.typescriptlang.org/docs/home.html) (front-end/back-end)
@@ -53,6 +63,8 @@ Allows for faster separate re-runs of some of the more involved processes:
- [ElectronJS](https://www.electronjs.org/docs) (chrome/node)
- [NodeJS](https://nodejs.org/dist/latest-v12.x/docs/api/) (api docs)
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/lensapp/lens.