Skip to content

Commit

Permalink
style: Use common contraction "you're" (#573)
Browse files Browse the repository at this point in the history
  • Loading branch information
prcr authored Mar 26, 2021
1 parent 2c65d4a commit 517c864
Show file tree
Hide file tree
Showing 17 changed files with 29 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Substitute the placeholders with your own values:
- **REPOSITORY_FULL_PATH:** Name of the organization and repository on the Git provider, using the format `<organization>/<repository>`. For example, `codacy/docs`. You must have admin permissions over the repository on the Git provider.
!!! important
**If you are using GitLab** you must specify the full group path and the repository using the format `<group>/<subgroup-1>/.../<subgroup-N>/<repository>`.
**If you're using GitLab** you must specify the full group path and the repository using the format `<group>/<subgroup-1>/.../<subgroup-N>/<repository>`.

Currently, Codacy doesn't provide API endpoints to automate other parts of setting up new repositories, such as configuring the repository settings or the enabled code patterns. However, Codacy automatically applies the [default patterns](../repositories-configure/code-patterns.md#set-default) defined on the Codacy API token account to the new repositories, and you can use this to ensure that all new repositories share the same pattern configuration.
Expand Down Expand Up @@ -93,5 +93,5 @@ done
!!! important
For the sake of simplicity:
- The GitHub API endpoint used by the script obtains all repositories in a GitHub organization. However, you must have admin permissions over the repositories that you add to Codacy. If you are not the owner of all the repositories in your GitHub organization, consider using the GitHub API endpoint [/user/repos](https://docs.github.com/en/rest/reference/repos#list-repositories-for-the-authenticated-user){: target="_blank"} instead.
- The GitHub API endpoint used by the script obtains all repositories in a GitHub organization. However, you must have admin permissions over the repositories that you add to Codacy. If you're not the owner of all the repositories in your GitHub organization, consider using the GitHub API endpoint [/user/repos](https://docs.github.com/en/rest/reference/repos#list-repositories-for-the-authenticated-user){: target="_blank"} instead.
- The script doesn't take into account paginated results obtained from the GitHub API. To ensure that you obtain all the repositories in your organization, [learn how to use pagination on the GitHub API](https://docs.github.com/en/rest/guides/traversing-with-pagination){: target="_blank"}.
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ If you need to make any changes to the emails showing in Codacy, you will need t

If the changes are still not reflected in Codacy, go to your [access management](https://app.codacy.com/account/access-management) page and revoke the relevant Git provider or Google integration. After that, please log out and back into Codacy with that provider.

If you are still having trouble changing your email addresses or have any other question regarding this, please contact us at <mailto:[email protected]>.
If you're still having trouble changing your email addresses or have any other questions regarding this, please contact us at <mailto:[email protected]>.
10 changes: 6 additions & 4 deletions docs/faq/general/why-cant-i-see-my-organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@

If you don't see your organization when [adding your organization on Codacy](../../organizations/what-are-synced-organizations.md#adding-an-organization), try the following steps:

1. Make sure you have access to the organization with the account you are logged in.
2. **If you're using GitHub Apps,** [install and authorize Codacy on your organization](https://github.com/apps/codacy-production/installations/new).
3. Refresh the list of organizations on Codacy by clicking **refresh this list** on the Organizations page:
1. Make sure you have access to the organization with the account you're logged in.

1. **If you're using GitHub Apps,** [install and authorize Codacy on your organization](https://github.com/apps/codacy-production/installations/new).

1. Refresh the list of organizations on Codacy by clicking **refresh this list** on the Organizations page:

![Refresh the list of organizations](images/organization-refresh-list.png)

4. Revoke Codacy's OAuth application on the Git provider website and log in again to Codacy.
1. Revoke Codacy's OAuth application on the Git provider website and log in again to Codacy.

If these steps don't solve the issue, please contact us at <mailto:[email protected]>.
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If the user that initially configured the repository on Codacy was using a user

**Generate New Repository Key** is the recommended option. It will add a new SSH key to your repository deployment keys. However, this is only possible if the user configuring the integration with the remote Git provider has permissions to add keys to the repository. Otherwise, this operation will fail. Alternatively, you can also do this process manually by copying the SSH key.

**Generate New User Key** should only be used if [your repository is using submodules on Codacy](../../repositories-configure/using-submodules.md). When you are using submodules, Codacy needs to clone additional repositories it has no access to. Since there is no way of identifying the submodules of a repository before cloning the repository, Codacy adds the SSH keys to the user account so that it has access to the same repositories as the user.
**Generate New User Key** should only be used if [your repository is using submodules on Codacy](../../repositories-configure/using-submodules.md). When you're using submodules, Codacy needs to clone additional repositories it has no access to. Since there is no way of identifying the submodules of a repository before cloning the repository, Codacy adds the SSH keys to the user account so that it has access to the same repositories as the user.

!!! important
**If you're using Bitbucket Cloud**, you must manually add the SSH key on your [user account](https://bitbucket.org/account/settings/ssh-keys/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ When this happens, Codacy doesn't display code duplication metrics for the affec

![Analysis logs for a commit](images/duplication-logs.png)

As a workaround, if you are exceeding the maximum number of source code files:
As a workaround, if you're exceeding the maximum number of source code files:

1. We recommend that you use a [Codacy configuration file](../../repositories-configure/codacy-configuration-file.md) to exclude source code files of the affected language from your project to decrease the number of files to be analyzed.

Expand All @@ -28,10 +28,10 @@ As a workaround, if you are exceeding the maximum number of source code files:

If the analysis finishes but the code duplication metric wasn't calculated, follow the next steps:

- **If you are using Codacy Self-hosted**, open the **Admin panel**, **Repositories**, select the repository, tab **Settings**, and reset the code duplication analysis in **Duplication settings**. Then, reanalyze the last commit in the repository so that Codacy runs the code duplication analysis.
- **If you're using Codacy Self-hosted**, open the **Admin panel**, **Repositories**, select the repository, tab **Settings**, and reset the code duplication analysis in **Duplication settings**. Then, reanalyze the last commit in the repository so that Codacy runs the code duplication analysis.

![Resetting the failed duplication analysis](images/duplication-metrics-reset.png)

- **If you are [analyzing your repository locally](../../related-tools/local-analysis/running-local-analysis.md)** with the Codacy Analysis CLI, consider using the flag `--tool-timeout` to specify a larger timeout for the execution of the tool.
- **If you're [analyzing your repository locally](../../related-tools/local-analysis/running-local-analysis.md)** with the Codacy Analysis CLI, consider using the flag `--tool-timeout` to specify a larger timeout for the execution of the tool.

- **If you are using Codacy Cloud** or if the steps above didn't solve the issue, please contact us at <mailto:[email protected]>.
- **If you're using Codacy Cloud** or if the steps above didn't solve the issue, please contact us at <mailto:[email protected]>.
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Have you added your repository manually (via URL)? In that case, Codacy won't allow the integration to be added, causing the issue with post-commit hooks. To get this sorted, you will have to remove your repository and re-add it via our wizard page.

If you are still unable to configure the integration, please contact us at <mailto:[email protected]>.
If you're still unable to configure the integration, please contact us at <mailto:[email protected]>.
4 changes: 2 additions & 2 deletions docs/faq/troubleshooting/why-is-my-file-missing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In your repository's **Files** page you can view all the files that Codacy detec

While this page should display all the files in your repository, here is a list of reasons why some files might be missing:

- **You are viewing the incorrect branch**
- **You're viewing the incorrect branch**

On the **Files** page you can select which branch to display, and sometimes not all files exist in all branches.

Expand Down Expand Up @@ -56,7 +56,7 @@ To update the file size limit:
1. Apply the new configuration by performing a Helm upgrade and specifying the Codacy Self-hosted version currently installed. To do so execute the command [used to install Codacy](../../chart/index.md#helm-upgrade):
!!! important
**If you are using MicroK8s** you must use the file `values-microk8s.yaml` together with the file `values-production.yaml`.
**If you're using MicroK8s** you must use the file `values-microk8s.yaml` together with the file `values-production.yaml`.

To do this, uncomment the last line before running the `helm upgrade` command below.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Share your repository with a non-Codacy user

If you are a Codacy Cloud user, you can share your Repository Dashboard with a non-Codacy user by using a link that doesn't require a login.
If you're a Codacy Cloud user, you can share your Repository Dashboard with a non-Codacy user by using a link that doesn't require a login.

To do this, click **Share** at the top of your Repository Dashboard.

Expand Down
2 changes: 1 addition & 1 deletion docs/organizations/organization-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ Click **See all** to see all repositories in your organization.
![Last updated repositories](images/organization-overview-repositories-last-updated.png)

!!! important
**If you are using Bitbucket Server** the list displays the repositories in alphabetical order because Codacy can't obtain the information on when the repositories were last updated from this Git provider.
**If you're using Bitbucket Server** the list displays the repositories in alphabetical order because Codacy can't obtain the information on when the repositories were last updated from this Git provider.
4 changes: 2 additions & 2 deletions docs/organizations/what-are-synced-organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This opens the list of organizations on your Git providers. The organization wit
- To add organizations from a Git provider not yet listed on this page, click **Add provider** and give the [necessary permissions](../getting-started/which-permissions-does-codacy-need-from-my-account.md) for Codacy to sync with the new Git provider and display your organizations.

!!! note
If you can't see the organization you are looking for, follow the instructions in the card **Adding new organizations** or [these troubleshooting instructions](../faq/general/why-cant-i-see-my-organization.md).
If you can't see the organization you're looking for, follow the instructions in the card **Adding new organizations** or [these troubleshooting instructions](../faq/general/why-cant-i-see-my-organization.md).

## Updates on the Git provider

Expand All @@ -45,7 +45,7 @@ To delete an organization, open the **Profile** page and click the button **Dele
![Deleting an organization](images/organization-delete.png)

!!! note
**If you're using Codacy Cloud** we will ask for your feedback on why you are deleting your organization.
**If you're using Codacy Cloud** we will ask for your feedback on why you're deleting your organization.

## See also

Expand Down
2 changes: 1 addition & 1 deletion docs/related-tools/local-analysis/running-aligncheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To run aligncheck as a [client-side tool](client-side-tools.md):

{% include "../../assets/includes/api-token-warning.txt" %}

1. **If you are using Codacy Self-hosted** set the following environment variable to specify your Codacy instance URL:
1. **If you're using Codacy Self-hosted** set the following environment variable to specify your Codacy instance URL:
```bash
export CODACY_API_BASE_URL=<your Codacy instance URL>
Expand Down
2 changes: 1 addition & 1 deletion docs/related-tools/local-analysis/running-deadcode.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To run deadcode as a [client-side tool](client-side-tools.md):

{% include "../../assets/includes/api-token-warning.txt" %}

1. **If you are using Codacy Self-hosted** set the following environment variable to specify your Codacy instance URL:
1. **If you're using Codacy Self-hosted** set the following environment variable to specify your Codacy instance URL:
```bash
export CODACY_API_BASE_URL=<your Codacy instance URL>
Expand Down
2 changes: 1 addition & 1 deletion docs/related-tools/local-analysis/running-spotbugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To run SpotBugs as a [client-side tool](client-side-tools.md):

{% include "../../assets/includes/api-token-warning.txt" %}

1. **If you are using Codacy Self-hosted** set the following environment variable to specify your Codacy instance URL:
1. **If you're using Codacy Self-hosted** set the following environment variable to specify your Codacy instance URL:
```bash
export CODACY_API_BASE_URL=<your Codacy instance URL>
Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/self-hosted/self-hosted-v3.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To upgrade Codacy, follow [these instructions](../../chart/maintenance/upgrade.m

## Breaking changes

**If you are using GitHub and require Codacy pull request status to pass before merging pull requests** you must manually re-enable the required status check on your repositories. To do this:
**If you're using GitHub and require Codacy pull request status to pass before merging pull requests** you must manually re-enable the required status check on your repositories. To do this:

1. Wait until there is a new status check from Codacy on your repositories using the new GitHub Checks integration:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There are two ways to do this: **automatically** or **manually**

## Automatic setup of post-commit hook

If you are using GitHub or Bitbucket you can let Codacy configure the hook for you. Go to your **repository settings** and click on the **Integrations** tab. There should be a switch button for the automatic setup of post-commit hooks.
If you're using GitHub or Bitbucket you can let Codacy configure the hook for you. Go to your **repository settings** and click on the **Integrations** tab. There should be a switch button for the automatic setup of post-commit hooks.

### Missing hook automatic setup switch button

Expand Down
4 changes: 2 additions & 2 deletions docs/repositories-configure/using-submodules.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ By default, Codacy does normal Git clones that don't include submodules to ensur

After we enabled submodules for your organization, do the following:

1. **If you are using Codacy Self-hosted**, you must [update the license](../chart/maintenance/license.md).
1. **If you're using Codacy Self-hosted**, you must [update the license](../chart/maintenance/license.md).

2. If your submodules are:

Expand All @@ -20,7 +20,7 @@ After we enabled submodules for your organization, do the following:
!!! important
**If you're using Bitbucket Cloud**, you must manually add the SSH key on your [user account](https://bitbucket.org/account/settings/ssh-keys/).

When you add a repository to Codacy, Codacy adds a new SSH key to your repository using an integration with your Git provider. Codacy uses this SSH key every time it needs to clone that repository. When you are using submodules, Codacy needs to clone additional repositories it has no access to. Since there is no way of identifying the submodules of a repository before cloning the repository, Codacy adds the SSH keys to the user account so that it has access to the same repositories as the user.
When you add a repository to Codacy, Codacy adds a new SSH key to your repository using an integration with your Git provider. Codacy uses this SSH key every time it needs to clone that repository. When you're using submodules, Codacy needs to clone additional repositories it has no access to. Since there is no way of identifying the submodules of a repository before cloning the repository, Codacy adds the SSH keys to the user account so that it has access to the same repositories as the user.

![Generate new user key](images/using-submodules-generate-new-user-key.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/repositories/security-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The Security Monitor displays issues using security patterns from:
- **SQL injection:** A SQL injection attack consists of insertion or "injection" of a SQL query via the input data from the client to the application.
- **Routes:** Badly configured routes can give unintended access to an attacker.
- **Regex:** Regex can be used in a Denial of Service attack, that exploits the fact that most Regular Expression implementations may reach heavy computation situations that cause them to work very slowly (exponentially related to input size).
- **SSL:** Simply using SSL isn't enough to ensure the data you are sending is secure. Man in the middle attacks are well known and widely used.
- **SSL:** Simply using SSL isn't enough to ensure the data you're sending is secure. Man in the middle attacks are well known and widely used.
- **Other:** Other language-specific security issues.

## Category states
Expand Down

0 comments on commit 517c864

Please sign in to comment.