Merge remote-tracking branch 'origin/master'

.github/workflows/ci.yml

@@ -42,7 +42,7 @@ jobs:
         with:
           mode: exactly
           count: 1
-          labels: "kind/bug, kind/cleanup, kind/feature, kind/i18n, dependencies"
+          labels: "kind/bug, kind/cleanup, kind/documentation, kind/feature, kind/i18n, dependencies"
 
   pull-request-title-check:
     name: Pull request title check

DEVELOPMENT.md

@@ -0,0 +1,64 @@
+# Development
+
+## Architecture
+
+The Kubernetes Dashboard consists of a few main modules:
+
+- API — Stateless Go module, which could be referred to as a Kubernetes API extension. It provides functionalities like:
+  - Aggregation (i.e., returning metrics and events for pods)
+  - Sorting
+  - Filtering
+  - Pagination
+- Auth — Go module handling authentication to the Kubernetes API.  
+- Web — Module containing web application written in Angular and Go server with some web-related logic (i.e., settings). Its main task is presenting data fetched from Kubernetes API through API module.
+- Metrics Scraper — Go module used to scrape and store a small window of metrics fetched from the Kubernetes Metrics Server.
+
+## Code Conventions
+
+When writing new Go code, we try to follow conventions described in [Effective Go](https://golang.org/doc/effective_go.html).  We are using [Go Report Card](https://goreportcard.com/report/github.com/kubernetes/dashboard) to monitor how well we are doing.
+
+For Angular, we try to follow conventions described in [Angular Style Guide](https://angular.io/guide/styleguide) and [Material Design Guidelines](https://material.io/guidelines/).
+
+We are running a set of checks for each pull request, all of them have to be successful before the change can be merged. You can run most of them locally using `make` targets, i.e. `make test` or `make check` (see [`Makefile`](Makefile) for more information).
+
+Tools that we are using include [golangci-lint](https://github.com/golangci/golangci-lint), [eslint](https://eslint.org), [stylelint](https://github.com/stylelint/stylelint), [prettier](https://prettier.io/).
+
+## Development Environment
+
+Make sure the following software is installed and added to your path:
+
+- [Docker](https://docs.docker.com/engine/install/) 
+- [Go](https://golang.org/dl/) (check the required version in [`modules/go.work`](modules/go.work))
+- [Node.js](https://nodejs.org/en/download) (check the required version in [`modules/web/package.json`](modules/web/package.json))
+- [Yarn](https://yarnpkg.com/getting-started/install) (check the required version in [`modules/web/.yarnrc.yml`](modules/web/.yarnrc.yml))
+
+## Getting Started
+
+After cloning the repository, install web dependencies with `cd modules/web && yarn`.
+
+Then you can start the development version of the application with `make serve` It will create local kind cluster and run all the modules with Docker compose.
+
+If you would like to run production version use `make run`
+
+To create Docker images locally use `make image`.
+
+See [`Makefile`](Makefile) to get to know other targets useful during development. You can also run `make help` to quickly check the list of available commands.
+
+## Dependency Management
+
+We keep all the dependencies outside the repository and always try to avoid using suspicious, unknown dependencies as they may introduce vulnerabilities.
+
+We use [go mod](https://github.com/golang/go/wiki/Modules) to manage Go dependencies. We try to use only official releases, avoid using specific or latest commits. Before sending any changes we run `go mod tidy` to remove unused dependencies.
+
+We use [Yarn](https://yarnpkg.com/) to manage JavaScript dependencies. After checking out repository, run `yarn` to install all dependencies.
+
+Additionally, we use [Dependabot](https://github.com/dependabot) to automate dependency updates.
+
+
+## Releases
+
+We follow [semver](https://semver.org/) versioning scheme for versioning releases of app and all of its modules.
+
+Each module described in the [Architecture section](#architecture) has its own releases and versions. After testing everything on a production version of application, i.e., using `make run`, new release can be created. For modules described above we create tag and the release with module name and its version in it, i.e.`api/v1.0.0` or `web/v2.4.5`. After a new tag is created, new images should be built by GitHub actions.
+
+We also create application releases by releasing a new version of Helm chart that uses modules described before. After applying all the changes to the chart and testing it on a Kubernetes cluster a new tag and the release can be created. For application releases we put only the version in the tag and release name, i.e. `v3.0.0`. This release should include detailed description including release notes, compatibility matrix and all other important information.

README.md

@@ -30,22 +30,18 @@ You can install Dashboard using `kubectl` as described in the installation instr
 
 ## Access
 
-You can access Dashboard as described in the instructions that can be found in the [access guide](docs/user/accessing-dashboard/README.md).
+You can access the Dashboard as described in the instructions that can be found in the [access guide](docs/user/accessing-dashboard/README.md).
 
 ## Create An Authentication Token (RBAC)
 To find out how to create sample user and log in follow [Creating sample user](docs/user/access-control/creating-sample-user.md) guide.
 
-**NOTE:**
-* Kubeconfig Authentication method does not support external identity providers or certificate-based authentication.
-* [Metrics-Server](https://github.com/kubernetes-sigs/metrics-server) has to be running in the cluster for the metrics and graphs to be available. Read more about it in [Integrations](docs/user/integrations.md) guide.
-
 ## Documentation
 
 Dashboard documentation can be found on [docs](docs/README.md) directory which contains:
 
 * [Common](docs/common/README.md): Entry-level overview.
 * [User Guide](docs/user/README.md): [Accessing Dashboard](docs/user/accessing-dashboard/README.md) and more for users.
-* [Developer Guide](docs/developer/README.md): Important information for contributors that would like to test, run and work on Dashboard locally.
+* [Developer Guide](DEVELOPMENT.md): Important information for contributors that would like to test, run and work on Dashboard locally.
 
 ## Community, discussion, contribution, and support
 

docs/README.md

@@ -4,6 +4,7 @@
 
 * [FAQ](common/faq.md)
 * [Dashboard arguments](common/arguments.md)
+* [Internationalization](common/internationalization.md)
 
 ## [User Guide](user/README.md)
 
@@ -13,15 +14,7 @@
 * [Integrations](user/integrations.md)
 * [Labels](user/labels.md)
 
-## [Developer Guide](developer/README.md)
-
-* [Getting started](developer/getting-started.md)
-* [Release procedures](developer/release-procedures.md)
-* [Dependency management](developer/dependency-management.md)
-* [Architecture](developer/architecture.md)
-* [Code conventions](developer/code-conventions.md)
-* [Text conventions](developer/text-conventions.md)
-* [Internationalization](developer/internationalization.md)
+## [Developer Guide](../DEVELOPMENT.md)
 
 ----
 _Copyright 2019 [The Kubernetes Dashboard Authors](https://github.com/kubernetes/dashboard/graphs/contributors)_

docs/common/faq.md

@@ -2,10 +2,6 @@
 
 In case you did not find any answer here and in [closed issues](https://github.com/kubernetes/dashboard/issues?q=is%3Aissue+is%3Aclosed), [create new issue](https://github.com/kubernetes/dashboard/issues/new/choose).
 
-### I would like to use development environment on HTTPS, how to do it?
-
-Refer to our [Developer guide](../developer/getting-started.md).
-
 ### I cannot see any graphs in Dashboard, how to enable them?
 
 Make sure, that `metrics-server` and `dashboard-metrics-scraper` are up and running and Dashboard was able to connect with `dashboard-metrics-scraper`. You should check Dashboard logs and look for `metric` and `scraper` keywords. You can find more informations about Dashboard's Integrations [here](../user/integrations.md).