-
Notifications
You must be signed in to change notification settings - Fork 919
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into support-tls-13
- Loading branch information
Showing
387 changed files
with
1,457 additions
and
29,350 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -62,6 +62,17 @@ We recommend using [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm) t | |
|
||
If it's the only version of node installed, it will automatically be set to the `default` alias. Otherwise, use `nvm list` to see all installed `node` versions, and `nvm use` to select the node version required by OpenSearch Dashboards. | ||
|
||
### Fork and clone OpenSearch Dashboards | ||
|
||
All local development should be done in a [forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo). | ||
Fork OpenSearch Dashboards by clicking the "Fork" button at the top of the [GitHub repository](https://github.com/opensearch-project/OpenSearch-Dashboards). | ||
|
||
Clone your forked version of OpenSearch Dashboards to your local machine (replace `opensearch-project` in the command below with your GitHub username): | ||
|
||
```bash | ||
$ git clone [email protected]:opensearch-project/OpenSearch-Dashboards.git | ||
``` | ||
|
||
#### Install `yarn` | ||
|
||
OpenSearch Dashboards is set up using yarn, which can be installed through corepack. To install yarn, run: | ||
|
@@ -76,17 +87,6 @@ $ corepack install | |
|
||
(See the [corepack documentation](https://github.com/nodejs/corepack#-corepack) for more information.) | ||
|
||
### Fork and clone OpenSearch Dashboards | ||
|
||
All local development should be done in a [forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo). | ||
Fork OpenSearch Dashboards by clicking the "Fork" button at the top of the [GitHub repository](https://github.com/opensearch-project/OpenSearch-Dashboards). | ||
|
||
Clone your forked version of OpenSearch Dashboards to your local machine (replace `opensearch-project` in the command below with your GitHub username): | ||
|
||
```bash | ||
$ git clone [email protected]:opensearch-project/OpenSearch-Dashboards.git | ||
``` | ||
|
||
### Bootstrap OpenSearch Dashboards | ||
|
||
If you haven't already, change directories to your cloned repository directory: | ||
|
@@ -929,30 +929,6 @@ license. | |
The following developer guide rules are specific for working with the React framework. | ||
#### Prefer reactDirective over react-component | ||
When using `ngReact` to embed your react components inside Angular HTML, prefer the | ||
`reactDirective` service over the `react-component` directive. | ||
You can read more about these two ngReact methods [here](https://github.com/ngReact/ngReact#features). | ||
Using `react-component` means adding a bunch of components into angular, while `reactDirective` keeps them isolated, and is also a more succinct syntax. | ||
**Good:** | ||
```html | ||
<hello-component | ||
fname="person.fname" | ||
lname="person.lname" | ||
watch-depth="reference" | ||
></hello-component> | ||
``` | ||
**Bad:** | ||
```html | ||
<react-component name="HelloComponent" props="person" watch-depth="reference" /> | ||
``` | ||
#### Name action functions and prop functions appropriately | ||
Name action functions in the form of a strong verb and passed properties in the form of on<Subject><Change>. E.g: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.