Skip to content

Commit

Permalink
Adding spaces after comma and colon
Browse files Browse the repository at this point in the history
  • Loading branch information
joaniefromtheblock committed Jul 10, 2024
1 parent 306f817 commit ea66d7a
Show file tree
Hide file tree
Showing 1,492 changed files with 14,693 additions and 13,608 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/build-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ jobs:
uses: ConsenSys/docs-gha/build@main
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}


lint:
name: Lint
Expand All @@ -39,4 +38,3 @@ jobs:
uses: ConsenSys/docs-gha/lint@main
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

12 changes: 6 additions & 6 deletions .github/workflows/crowdin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ name: Crowdin Action

on:
push:
path: [ "i18n/**" ]
branches: [ main ]
path: ["i18n/**"]
branches: [main]

permissions: write-all

Expand All @@ -23,10 +23,10 @@ jobs:
localization_branch_name: l10n_crowdin_translations

create_pull_request: true
pull_request_title: 'New Crowdin translations'
pull_request_body: 'New Crowdin pull request with translations'
pull_request_base_branch_name: 'main'
pull_request_title: "New Crowdin translations"
pull_request_body: "New Crowdin pull request with translations"
pull_request_base_branch_name: "main"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
6 changes: 3 additions & 3 deletions .github/workflows/security-code-scanner.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: 'MetaMask Security Code Scanner'
name: "MetaMask Security Code Scanner"

on:
push:
branches: ['main']
branches: ["main"]
pull_request:
branches: ['main']
branches: ["main"]

jobs:
run-security-scan:
Expand Down
2 changes: 1 addition & 1 deletion .yarn/releases/yarn-3.4.1.cjs

Large diffs are not rendered by default.

40 changes: 21 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ guide in some places.
- [Style guide](#style-guide)
- [Add images](#add-images)
- [Format Markdown and MDX](#format-markdown-and-mdx)
- [Live code blocks](#live-code-blocks)
- [Live code blocks](#live-code-blocks)

## Contribution workflow

Expand All @@ -34,10 +34,10 @@ To contribute changes:
2. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
this repository to your computer and navigate into it.

```bash
git clone https://github.com/MetaMask/metamask-docs.git
cd metamask-docs
```
```bash
git clone https://github.com/MetaMask/metamask-docs.git
cd metamask-docs
```

> **Note**: If you don't have write access to this repository, you must [fork the
> repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)
Expand All @@ -56,9 +56,9 @@ To contribute changes:
We recommend including the issue number and a short description in the branch name (for example,
`183-doc-cli-option`), which is a reminder to fix only one issue in a PR.
```bash
git checkout -b <ISSUE-NUM>-<ISSUE-DESC>
```
```bash
git checkout -b <ISSUE-NUM>-<ISSUE-DESC>
```
> **Tip:** You can use a Git client such as [Fork](https://fork.dev/) instead of the command line.
Expand All @@ -68,6 +68,7 @@ To contribute changes:
and [format your Markdown correctly](https://docs-template.consensys.net/contribute/format-markdown).
> **Notes:**
>
> - All documentation content is located in the `wallet` and `snaps` directories.
> - If you add a new documentation page, make sure to edit `wallet-sidebar.js` or
> `snaps-sidebar.js` to add the page to the
Expand All @@ -81,27 +82,27 @@ To contribute changes:
6. Add and commit your changes, briefly describing your changes in the commit message.
Push your changes to the remote origin.
```bash
git add .
git commit -m "<COMMIT-MESSAGE>"
git push origin
```
```bash
git add .
git commit -m "<COMMIT-MESSAGE>"
git push origin
```
7. On [this repository on GitHub](https://github.com/MetaMask/metamask-docs), you’ll see a banner
prompting you to create a PR with your recent changes.
Create a PR, describing your changes in detail.
[Link the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
that your PR fixes by adding `fixes #<ISSUE-NUM>` to the PR description.
9. Specific reviewers are automatically requested when you submit a PR.
8. Specific reviewers are automatically requested when you submit a PR.
You can request additional reviewers in the right sidebar of your PR – for example, the original
issue raiser.
Make any required changes to your PR based on reviewer feedback, repeating steps 5–7.
9. After your PR is approved by two reviewers, all checks have passed, and your branch has no
conflicts with the main branch, you can merge your PR.
If you don't have merge access, a maintainer will merge your PR for you.
You can delete the topic branch after your PR is merged.
conflicts with the main branch, you can merge your PR.
If you don't have merge access, a maintainer will merge your PR for you.
You can delete the topic branch after your PR is merged.

## Preview locally

Expand Down Expand Up @@ -139,7 +140,7 @@ Define a live code block by adding a `codesandbox` key to the code block.
For example:
````jsx
```javascript codesandbox=vanilla
;```javascript codesandbox=vanilla
// JavaScript live code block
```
````
Expand All @@ -160,8 +161,9 @@ If you need to test analytics events in your local development environment be su
```bash
export SEGMENT_ANALYTICS_KEY="<your key>"
```
Then build the project in production mode using the following command:
```bash
yarn build && yarn serve
```
```
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,31 +19,31 @@ Build the documentation site locally using the following steps.

1. Clone the repository.

```bash
git clone https://github.com/MetaMask/metamask-docs.git
cd metamask-docs
```

> **Note:** If you don't have write access to this repository, you must [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) to your personal account and clone your forked repository instead. [Add an upstream remote](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository) to be able to pull from and push to the original repository.
>
> ```bash
> git clone https://github.com/<YOUR-USERNAME>/metamask-docs.git
> cd metamask-docs
> git remote add upstream https://github.com/MetaMask/metamask-docs.git
> ```
```bash
git clone https://github.com/MetaMask/metamask-docs.git
cd metamask-docs
```

> **Note:** If you don't have write access to this repository, you must [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) to your personal account and clone your forked repository instead. [Add an upstream remote](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository) to be able to pull from and push to the original repository.
>
> ```bash
> git clone https://github.com/<YOUR-USERNAME>/metamask-docs.git
> cd metamask-docs
> git remote add upstream https://github.com/MetaMask/metamask-docs.git
> ```
2. Install dependencies.
```bash
yarn install
```
```bash
yarn install
```
3. Start the development server.
```bash
yarn start
```
Once the server starts, you can view the documentation at `http://localhost:3000`.
```bash
yarn start
```
Once the server starts, you can view the documentation at `http://localhost:3000`.
For more information on contributing to the documentation, see the [full contribution guidelines](CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion babel.config.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module.exports = {
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
};
}
2 changes: 1 addition & 1 deletion crowdin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ files:
- source: /services/**/*
translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%
- source: /docs/**/*
translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%
translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%
5 changes: 2 additions & 3 deletions dashboard-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ const sidebar = {
items: [{ type: "autogenerated", dirName: "how-to" }],
},
],
};

module.exports = sidebar;
}

module.exports = sidebar
19 changes: 10 additions & 9 deletions developer-tools/dashboard/get-started/create-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,14 @@ To create an API key:
1. Open the [Infura dashboard](https://infura.io/dashboard). Enter your login details, if required.
1. Select **CREATE NEW API KEY**.

<div class="left-align-container">
<div class="img-large">
<img
src={require('../../images/create_key.png').default}
/>
</div>
</div>
<div class="left-align-container">
<div class="img-large">
<img
src={require('../../images/create_key.png').default}
/>
</div>
</div>

1. From the pop-up window, provide a name, then click **CREATE**.
1. Select the networks that you want your API key to access, and select **Save Changes**.

Expand All @@ -49,5 +50,5 @@ We recommend the following best practices when creating your API keys:
- Group API key endpoints by groups or individuals [sharing the API key](../how-to/project-sharing.md).
- Limit the number of networks or services per API key only to the necessary endpoints.
- Group the API key endpoints based on shared security considerations such as
[allowlists](../how-to/secure-an-api/use-an-allowlist.md) or
[key request volume limits](../how-to/secure-an-api/set-rate-limits.md).
[allowlists](../how-to/secure-an-api/use-an-allowlist.md) or
[key request volume limits](../how-to/secure-an-api/set-rate-limits.md).
29 changes: 15 additions & 14 deletions developer-tools/dashboard/how-to/dashboard-stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,27 @@ This data is crucial for optimizing your applications and ensuring they run smoo
## Specify stats to view

1. In the top menu of the [Infura dashboard](https://app.infura.io/), select **Stats**.
The stats page displays the total volume of requests sent to Infura over the specified time period.
By default, data is shown from the last 24 hours from all Web3 API keys.
The stats page displays the total volume of requests sent to Infura over the specified time period.
By default, data is shown from the last 24 hours from all Web3 API keys.

2. To change the API key, make a selection from the API keys dropdown.

3. To change the stats time range, make a selection from the time dropdown.
Time values are given in Coordinated Universal Time (UTC).
For Web3 API usage, you can choose from the following options:
- **Last 15 Minutes** - The last completed 15 minutes.
This updates once a minute.
- **Last 1 Hour** - The last fully completed hour, from 0 to 59 minutes and 59 seconds.
- **Last 24 Hours** - The last fully completed 24 consecutive hours.
This is the default.
- **Last 7 Days** - The last fully completed seven consecutive days.
A day appears once it has completed.
- **Last 30 Days** - The last fully completed 30 days.
A day appears once it has completed.
Time values are given in Coordinated Universal Time (UTC).
For Web3 API usage, you can choose from the following options:

- **Last 15 Minutes** - The last completed 15 minutes.
This updates once a minute.
- **Last 1 Hour** - The last fully completed hour, from 0 to 59 minutes and 59 seconds.
- **Last 24 Hours** - The last fully completed 24 consecutive hours.
This is the default.
- **Last 7 Days** - The last fully completed seven consecutive days.
A day appears once it has completed.
- **Last 30 Days** - The last fully completed 30 days.
A day appears once it has completed.

4. To view your IPFS usage, select **IPFS Usage** in the toggle in the top-right corner.
You can choose to show data from the **Last 24 Hours** (default) or the **Last 7 Days**.
You can choose to show data from the **Last 24 Hours** (default) or the **Last 7 Days**.

## Web3 stats charts

Expand Down
2 changes: 1 addition & 1 deletion developer-tools/dashboard/how-to/network-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ You can also select the **Status** link at the top of the Infura dashboard to vi
src={require('../../images/status-page.png').default}
/>
</div>
</div>
</div>
20 changes: 10 additions & 10 deletions developer-tools/dashboard/how-to/secure-an-api/_category_.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"position": 3,
"label": "Secure an API",
"collapsible": true,
"collapsed": true,
"link": {
"type": "generated-index",
"slug": "dashboard/secure-an-api",
"description": "This section provides information about how to secure your API key using Infura's security settings."
}
}
"position": 3,
"label": "Secure an API",
"collapsible": true,
"collapsed": true,
"link": {
"type": "generated-index",
"slug": "dashboard/secure-an-api",
"description": "This section provides information about how to secure your API key using Infura's security settings."
}
}
18 changes: 9 additions & 9 deletions developer-tools/dashboard/how-to/secure-an-api/api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ security features such as [JSON Web Tokens (JWTs)](use-jwts.md) and [allowlists]
Securing your Infura API key is crucial to protect your project resources and data. Here are some best practices to
secure your Infura API key:

* **Do not share publicly.** Never share your API key publicly, such as in public repositories, client-side code, or public
forums. This is equivalent to giving away your password.
- **Do not share publicly.** Never share your API key publicly, such as in public repositories, client-side code, or public
forums. This is equivalent to giving away your password.

* **Use environment variables.** When developing locally or deploying your application, store your
[API key in environment variables](../../../../../services/how-to/javascript-dotenv) instead of hardcoding it into
your application. This prevents the API key from being exposed in your codebase.
- **Use environment variables.** When developing locally or deploying your application, store your
[API key in environment variables](../../../../../services/how-to/javascript-dotenv) instead of hardcoding it into
your application. This prevents the API key from being exposed in your codebase.

* **Limit usage.** Infura allows you to [set daily request limits on your API key](set-rate-limits.md). Setting a limit can
prevent excessive usage if your API key is exposed accidentally.
- **Limit usage.** Infura allows you to [set daily request limits on your API key](set-rate-limits.md). Setting a limit can
prevent excessive usage if your API key is exposed accidentally.

* **Monitor usage.** Observe the [usage statistics of your API key](../dashboard-stats.md). If you notice an unexpected
increase in usage, it might indicate that your API key has been compromised.
- **Monitor usage.** Observe the [usage statistics of your API key](../dashboard-stats.md). If you notice an unexpected
increase in usage, it might indicate that your API key has been compromised.
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ To allow a specific Ethereum address, click **ADD** and input it into the **CONT
</div>
</div>


Test with a method from the list.

```bash
Expand Down Expand Up @@ -194,14 +193,14 @@ URL isn't on your allowlist, provided they include both the API key and the API
This feature provides the following benefits:

- **Principle of least privilege on the client side** - On the client side of your dapp, you may wish
to limit the actions possible with your API key to only those necessary for the application's
functionality. Allowlists ensure the API key is used solely for authorized locations, smart contract
addresses, or methods.
to limit the actions possible with your API key to only those necessary for the application's
functionality. Allowlists ensure the API key is used solely for authorized locations, smart contract
addresses, or methods.

- **No restrictions server side** - On the server side, where the API key secret can be stored
securely, you might need to carry out a broader range of actions without the constraints of
allowlists. Using the API key secret allows you to circumvent these restrictions, giving your
server-side application unrestricted use of the API key.
securely, you might need to carry out a broader range of actions without the constraints of
allowlists. Using the API key secret allows you to circumvent these restrictions, giving your
server-side application unrestricted use of the API key.

## Best practices

Expand Down
Loading

0 comments on commit ea66d7a

Please sign in to comment.