From d40c9f5226046a0a43dc66e3f3ce0057c61a9b6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia=20Carpinteiro?= Date: Thu, 27 Jun 2024 17:26:08 +0100 Subject: [PATCH 1/8] feat: Add organization configuration to quickstart guided path --- .../includes/nav-multistep-quickstart.md | 15 +++++- .../configuring-your-organization.md | 52 +++++++++++++++++++ .../configuring-your-repository.md | 2 +- ...tegrating-codacy-with-your-git-workflow.md | 2 +- mkdocs.yml | 1 + 5 files changed, 68 insertions(+), 4 deletions(-) create mode 100644 docs/getting-started/configuring-your-organization.md diff --git a/docs/assets/includes/nav-multistep-quickstart.md b/docs/assets/includes/nav-multistep-quickstart.md index 4445e94012..796697ea00 100644 --- a/docs/assets/includes/nav-multistep-quickstart.md +++ b/docs/assets/includes/nav-multistep-quickstart.md @@ -15,16 +15,27 @@
  • {% if page.meta.nav_step == 1 %}

    - Configuring your repository + Configuring your organization

    {% else %} - Configuring your repository + Configuring your organization {% endif %}
  • {% if page.meta.nav_step == 2 %} +

    + Configuring your repository +

    + {% else %} + + Configuring your repository + + {% endif %} +
    • +
  • + {% if page.meta.nav_step == 3 %}

    Integrating Codacy with your Git workflow

    diff --git a/docs/getting-started/configuring-your-organization.md b/docs/getting-started/configuring-your-organization.md new file mode 100644 index 0000000000..759ff0565a --- /dev/null +++ b/docs/getting-started/configuring-your-organization.md @@ -0,0 +1,52 @@ +--- +description: Configure your Codacy organization to align with your corporate policies and ensure consistent code quality across your repositories. +nav_step: 1 +--- + +# Configuring your organization + +{% include-markdown "../assets/includes/nav-multistep-quickstart.md" %} + +Now that you are familiar with Codacy, you might want to configure your Codacy organization to align with your corporate policies and ensure consistent code quality across your repositories. + +To configure your organization, follow these steps: + +1. [Configuring repository management permissions](#repository-permissions) +1. [Assigning organization manager role](#org-manager) +1. [Defining gate policies](#gate-policies) +1. [Defining coding standards](#coding-standards) +1. [Configuring default Git provider integration settings](#git-provider-settings) + +## 1. Configuring repository management permissions {: id="repository-permissions"} + +[Define the Codacy roles](../organizations/roles-and-permissions-for-organizations.md#change-analysis-configuration) that can configure patterns, analyzed languages and branches, ignore issues and files, and reanalyze branches and pull requests. + +![Configuring repository management permissions](../organizations/images/roles-permissions-repo-management.png) + +## 2. Assigning the organization manager role {: id="org-manager"} + +[Assign the organization manager role](../organizations/roles-and-permissions-for-organizations.md#managing-the-organization-manager-role) to members of your organization to grant them additional permissions without changing their permissions on the Git provider. For example, they will be able to manage your organization policies and integrations. + +![Assign the organization manager role](../organizations/images/roles-permissions-organization-manager-assign.png) + +## 3. Defining gate policies {: id="gate-policies"} + +[Define gate policies](../organizations/using-gate-policies.md) to ensure that Codacy uses the same quality gates across your organization repositories. + +![Creating a new gate policy](../organizations/images/gate-policy-create.png) + +## 4. Defining coding standards {: id="coding-standards"} + +[Define coding standards](../organizations/using-coding-standards.md) to ensure that multiple repositories consistently follow the same global tool and code pattern configurations. + +![Creating a new coding standard](../organizations/images/coding-standard-create.png) + +## 5. Configuring default Git provider integration settings {: id="git-provider-settings"} + +[Configure the default settings that Codacy uses to integrate with your Git provider](../organizations/integrations/default-git-provider-integration-settings.md) when you add a new repository to Codacy. This enables you to apply the same settings across your organization repositories. + +![Default Git provider integration settings](../organizations/images/default-git-provider-settings.png) + +## Next steps {: id="next-steps"} + +Now that you set up the global settings for your organization, see how to [configure any specific settings for each repository](./configuring-your-repository.md). diff --git a/docs/getting-started/configuring-your-repository.md b/docs/getting-started/configuring-your-repository.md index 2d199ac1e0..b08ccecd54 100644 --- a/docs/getting-started/configuring-your-repository.md +++ b/docs/getting-started/configuring-your-repository.md @@ -1,6 +1,6 @@ --- description: Configure Codacy to match the coding conventions and best practices that your team may already be following or that you want to promote. -nav_step: 1 +nav_step: 2 --- # Configuring your repository diff --git a/docs/getting-started/integrating-codacy-with-your-git-workflow.md b/docs/getting-started/integrating-codacy-with-your-git-workflow.md index 4dab9165c8..82ca6cef59 100644 --- a/docs/getting-started/integrating-codacy-with-your-git-workflow.md +++ b/docs/getting-started/integrating-codacy-with-your-git-workflow.md @@ -1,6 +1,6 @@ --- description: Integrate Codacy with your Git workflow to display analysis results and code coverage as status checks on your pull requests and optionally block merging pull requests. -nav_step: 2 +nav_step: 3 --- # Integrating Codacy with your Git workflow diff --git a/mkdocs.yml b/mkdocs.yml index da2f5a4409..edd5b4615a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -553,6 +553,7 @@ nav: - Documentation home: "index.md" - Getting started: - getting-started/codacy-quickstart.md + - getting-started/configuring-your-organization.md - getting-started/configuring-your-repository.md - getting-started/integrating-codacy-with-your-git-workflow.md - Integrating Codacy with your IDE: From 9e2fcc463315fc190e449958b19151a66bc2f2c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia=20Carpinteiro?= Date: Thu, 27 Jun 2024 17:41:23 +0100 Subject: [PATCH 2/8] fix: Fix image link --- docs/getting-started/configuring-your-organization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/configuring-your-organization.md b/docs/getting-started/configuring-your-organization.md index 759ff0565a..c2622aabd3 100644 --- a/docs/getting-started/configuring-your-organization.md +++ b/docs/getting-started/configuring-your-organization.md @@ -45,7 +45,7 @@ To configure your organization, follow these steps: [Configure the default settings that Codacy uses to integrate with your Git provider](../organizations/integrations/default-git-provider-integration-settings.md) when you add a new repository to Codacy. This enables you to apply the same settings across your organization repositories. -![Default Git provider integration settings](../organizations/images/default-git-provider-settings.png) +![Default Git provider integration settings](../organizations/integrations/images/default-git-provider-settings.png) ## Next steps {: id="next-steps"} From 498d1ed35a6f6d509e8f657ecf2d528b47fbdf4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia=20Carpinteiro?= Date: Thu, 27 Jun 2024 17:45:00 +0100 Subject: [PATCH 3/8] fix: Fix link in guided path --- docs/assets/includes/nav-multistep-quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/assets/includes/nav-multistep-quickstart.md b/docs/assets/includes/nav-multistep-quickstart.md index 796697ea00..ee129aeab0 100644 --- a/docs/assets/includes/nav-multistep-quickstart.md +++ b/docs/assets/includes/nav-multistep-quickstart.md @@ -18,7 +18,7 @@ Configuring your organization

    {% else %} - + Configuring your organization {% endif %} From 49ec898348d8253cd3ad2c7ed92651f5ba70e4e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia=20Carpinteiro?= Date: Mon, 1 Jul 2024 17:48:29 +0100 Subject: [PATCH 4/8] feat: Set add organization as first step and move repository adding to org configuration --- docs/getting-started/codacy-quickstart.md | 22 +++---------------- .../configuring-your-organization.md | 20 +++++++++++++++-- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/getting-started/codacy-quickstart.md b/docs/getting-started/codacy-quickstart.md index f8fd14bc58..05b01a4c19 100644 --- a/docs/getting-started/codacy-quickstart.md +++ b/docs/getting-started/codacy-quickstart.md @@ -18,7 +18,7 @@ By integrating with your Git provider, Codacy keeps track of your team’s work, - **Duplication**: the amount of duplicated portions of code - **Coverage**: the percentage of lines of code covered by automated tests -## Adding your first repository +## Adding your organization to Codacy {% include-markdown "../assets/includes/nav-multistep-quickstart.md" %} @@ -26,7 +26,6 @@ To get started, head to [codacy.com](https://www. 1. [Signing up](#signing-up) 1. [Choosing an organization](#choosing-organization) -1. [Adding repositories](#adding-repositories) ## 1. Signing up {: id="signing-up"} @@ -38,28 +37,13 @@ Codacy will request access to your Git provider during the authorization flow. [ Now, you'll need to add or join the organizations that contain your repositories. The organization with the same name as your Git provider username contains your personal repositories. Read more about [organizations on Codacy](../organizations/what-are-organizations.md). -To start adding your repositories, select one of the organizations. +To proceed, select one of the organizations. !!! note If you can't see the organization you're looking for, [follow these troubleshooting instructions](../faq/troubleshooting/why-cant-i-see-my-organization.md). ![Choosing an organization](../organizations/images/organization-add.png) -## 3. Adding repositories {: id="adding-repositories"} - -Next, add the repositories that you wish to analyze. Codacy begins an initial analysis as soon as you add a repository and sets everything up to ensure your next commits on that repository are analyzed. - -!!! note - You can only add repositories on Codacy if you have the [necessary permissions on your Git provider](../organizations/roles-and-permissions-for-organizations.md). - -![Adding repositories](../organizations/images/repositories-add.png) - -Click the repository name to navigate to the repository dashboard and see the [code quality overview of your repository](../repositories/repository-dashboard.md) as soon as the initial analysis is complete: - -![Repository dashboard](../repositories/images/repository-dashboard.png) - -**Congratulations, your new repository is ready!** To explore the initial analysis results, [check the **Issues** page](../repositories/issues.md). - ## Next steps -The first analysis is based on default tool and pattern configurations. It's now important that you configure your repository to integrate code analysis seamlessly into your existing pipeline. See how to [configure your repository to match the use cases of your team](configuring-your-repository.md). +Before adding your repositories to Codacy, it's important that you [configure your organization](./configuring-your-organization.md) to align with your corporate policies and ensure consistent code quality across your repositories. diff --git a/docs/getting-started/configuring-your-organization.md b/docs/getting-started/configuring-your-organization.md index c2622aabd3..02c69ae601 100644 --- a/docs/getting-started/configuring-your-organization.md +++ b/docs/getting-started/configuring-your-organization.md @@ -7,7 +7,7 @@ nav_step: 1 {% include-markdown "../assets/includes/nav-multistep-quickstart.md" %} -Now that you are familiar with Codacy, you might want to configure your Codacy organization to align with your corporate policies and ensure consistent code quality across your repositories. +Once you've added your organization to Codacy, it's important that you align it with your corporate policies and ensure consistent code quality across your repositories. To configure your organization, follow these steps: @@ -16,6 +16,7 @@ To configure your organization, follow these steps: 1. [Defining gate policies](#gate-policies) 1. [Defining coding standards](#coding-standards) 1. [Configuring default Git provider integration settings](#git-provider-settings) +1. [Adding repositories](#adding-repositories) ## 1. Configuring repository management permissions {: id="repository-permissions"} @@ -47,6 +48,21 @@ To configure your organization, follow these steps: ![Default Git provider integration settings](../organizations/integrations/images/default-git-provider-settings.png) +## 6. Adding repositories {: id="adding-repositories"} + +Next, add the repositories that you wish to analyze. Codacy begins an initial analysis as soon as you add a repository and sets everything up to ensure your next commits on that repository are analyzed. + +!!! note + You can only add repositories on Codacy if you have the [necessary permissions on your Git provider](../organizations/roles-and-permissions-for-organizations.md). + +![Adding repositories](../organizations/images/repositories-add.png) + +Click the repository name to navigate to the repository dashboard and see the [code quality overview of your repository](../repositories/repository-dashboard.md) as soon as the initial analysis is complete: + +![Repository dashboard](../repositories/images/repository-dashboard.png) + +To explore the initial analysis results, [check the **Issues** page](../repositories/issues.md). + ## Next steps {: id="next-steps"} -Now that you set up the global settings for your organization, see how to [configure any specific settings for each repository](./configuring-your-repository.md). +The first analysis is based on the organization policies and standards that you previously defined, or Codacy defaults if you haven't defined your own policies. It's now important that you [configure specific rules for each repository](configuring-your-repository.md) to integrate code analysis seamlessly into your existing pipeline. From 0d87892d511c98974d91022af102910c18c84547 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia=20Carpinteiro?= Date: Mon, 1 Jul 2024 17:53:15 +0100 Subject: [PATCH 5/8] feat: Reinforce that new repositories follow org policies --- docs/getting-started/configuring-your-organization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/configuring-your-organization.md b/docs/getting-started/configuring-your-organization.md index 02c69ae601..e17a4b4d44 100644 --- a/docs/getting-started/configuring-your-organization.md +++ b/docs/getting-started/configuring-your-organization.md @@ -7,7 +7,7 @@ nav_step: 1 {% include-markdown "../assets/includes/nav-multistep-quickstart.md" %} -Once you've added your organization to Codacy, it's important that you align it with your corporate policies and ensure consistent code quality across your repositories. +Once you've added your organization to Codacy, it's important that you align it with your corporate policies and ensure consistent code quality across your repositories. When adding new repositories to Codacy, they follow the defined organization policies. To configure your organization, follow these steps: From 871a1946ff28281be8a07c6b60548adb5a1d00aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia=20Carpinteiro?= Date: Mon, 1 Jul 2024 18:21:38 +0100 Subject: [PATCH 6/8] feat: Adjust content to the new step --- docs/getting-started/configuring-your-organization.md | 4 ++-- docs/getting-started/configuring-your-repository.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/getting-started/configuring-your-organization.md b/docs/getting-started/configuring-your-organization.md index e17a4b4d44..6d825711f3 100644 --- a/docs/getting-started/configuring-your-organization.md +++ b/docs/getting-started/configuring-your-organization.md @@ -7,7 +7,7 @@ nav_step: 1 {% include-markdown "../assets/includes/nav-multistep-quickstart.md" %} -Once you've added your organization to Codacy, it's important that you align it with your corporate policies and ensure consistent code quality across your repositories. When adding new repositories to Codacy, they follow the defined organization policies. +Once you've added your organization to Codacy, it's important that you align it with your corporate policies and configure it to match the coding conventions and best practices that your team may already be following or that you want to promote. It's also critical to review the configurations to avoid reporting false positives or any other issues that don't bring value to your team, which can introduce unwanted delays to the development process. To configure your organization, follow these steps: @@ -65,4 +65,4 @@ To explore the initial analysis results, [check the **Issues** page](../reposito ## Next steps {: id="next-steps"} -The first analysis is based on the organization policies and standards that you previously defined, or Codacy defaults if you haven't defined your own policies. It's now important that you [configure specific rules for each repository](configuring-your-repository.md) to integrate code analysis seamlessly into your existing pipeline. +The first analysis is based on the organization policies and standards that you previously defined, or Codacy defaults if you haven't defined your own policies. This ensures consistent code quality across your repositories. It's now important that you [configure specific rules for each repository](configuring-your-repository.md) to integrate code analysis seamlessly into your existing pipeline. diff --git a/docs/getting-started/configuring-your-repository.md b/docs/getting-started/configuring-your-repository.md index b08ccecd54..ebeb6a48be 100644 --- a/docs/getting-started/configuring-your-repository.md +++ b/docs/getting-started/configuring-your-repository.md @@ -7,14 +7,14 @@ nav_step: 2 {% include-markdown "../assets/includes/nav-multistep-quickstart.md" %} -Once you've added your first repository, it's important that you configure Codacy's analysis tools to match the use cases of your team, such as configuring any coding conventions and best practices that your team may already be following or that you want to promote. It's also critical to review the configurations to avoid reporting false positives or any other issues that don't bring value to your team, which can introduce unwanted delays to the development process. +When adding your repositories to Codacy, the first analysis is based on the organization policies and standards. It's now important that you adjust for each repository any specific configuration where the organization settings don't apply. -You can optionally add coverage reports to detail how much of your code is covered by tests and unify your quality and coverage pipelines. You can generate coverage reports and upload them to Codacy using a range of options, such as CI/CD integration, CLI, Docker, GitHub action, and more. +You can optionally add coverage reports to detail how much of your repository code is covered by tests and unify your quality and coverage pipelines. You can generate coverage reports and upload them to Codacy using a range of options, such as CI/CD integration, CLI, Docker, GitHub action, and more. To configure your repository, follow these steps: 1. [Ignoring files](#ignoring-files) -1. [Configuring code patterns](#configuring-code-patterns) +1. [Adjusting code pattern configuration](#configuring-code-patterns) 1. [Adding coverage reports](#adding-coverage) (optional) ## 1. Ignoring files {: id="ignoring-files"} @@ -23,9 +23,9 @@ To configure your repository, follow these steps: ![Ignoring files](../repositories-configure/images/ignored-files.png) -## 2. Configuring code patterns {: id="configuring-code-patterns"} +## 2. Adjusting code pattern configuration {: id="configuring-code-patterns"} -[Configure the tools and code patterns](../repositories-configure/configuring-code-patterns.md) that Codacy uses to analyze your repository. If security is important for your team, review the [security and risk management dashboard](../organizations/managing-security-and-risk.md) to ensure that your configuration detects potential security issues. +[Adjust the tools and code patterns](../repositories-configure/configuring-code-patterns.md) that Codacy uses to analyze your repository. If security is important for your team, review the [security and risk management dashboard](../organizations/managing-security-and-risk.md) to ensure that your configuration detects potential security issues. !!! tip To ensure that multiple repositories consistently follow the same global tool and code pattern configurations, [use an organization coding standard](../organizations/using-coding-standards.md). From 922a7e0d4f68d522ee9181b52d3f2a977e6f7a2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia=20Carpinteiro?= Date: Mon, 1 Jul 2024 18:27:42 +0100 Subject: [PATCH 7/8] feat: Adjust guided path steps --- docs/assets/includes/nav-multistep-quickstart.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/assets/includes/nav-multistep-quickstart.md b/docs/assets/includes/nav-multistep-quickstart.md index ee129aeab0..18f529d193 100644 --- a/docs/assets/includes/nav-multistep-quickstart.md +++ b/docs/assets/includes/nav-multistep-quickstart.md @@ -4,11 +4,11 @@
  • {% if page.meta.nav_step == 0 %}

    - Adding your first repository + Adding your organization to Codacy

    {% else %} - - Adding your first repository + + Adding your organization to Codacy {% endif %}
    • From 81f61b98a17f2f12ce8f32bfc676c0b992f5c7bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia=20Carpinteiro?= Date: Mon, 1 Jul 2024 18:39:02 +0100 Subject: [PATCH 8/8] fix: Fix links --- docs/getting-started/integrating-codacy-with-intellij-ides.md | 2 +- .../integrating-codacy-with-visual-studio-code.md | 2 +- docs/release-notes/cloud/cloud-2023-06.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/integrating-codacy-with-intellij-ides.md b/docs/getting-started/integrating-codacy-with-intellij-ides.md index 8ecbe18c82..d288b2ef8c 100644 --- a/docs/getting-started/integrating-codacy-with-intellij-ides.md +++ b/docs/getting-started/integrating-codacy-with-intellij-ides.md @@ -31,7 +31,7 @@ In the main view, you can find the following information: 1. Make sure that the repository you’re working on is analyzed by Codacy and that you have a [repository read](../organizations/roles-and-permissions-for-organizations.md) role or higher. !!! tip - If this is your first time using Codacy, see [how to add and analyze your first repository](./codacy-quickstart.md#adding-your-first-repository). + If this is your first time using Codacy, see [how to get started](./codacy-quickstart.md#adding-your-organization-to-codacy). 1. Install the plugin from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23924-codacy) or through the [plugin settings panel](https://www.jetbrains.com/help/idea/managing-plugins.html) in your IntelliJ IDE. diff --git a/docs/getting-started/integrating-codacy-with-visual-studio-code.md b/docs/getting-started/integrating-codacy-with-visual-studio-code.md index 339c659c73..a2fd8e428e 100644 --- a/docs/getting-started/integrating-codacy-with-visual-studio-code.md +++ b/docs/getting-started/integrating-codacy-with-visual-studio-code.md @@ -73,7 +73,7 @@ See [how to manage the analysis of your repository's branches](../repositories-c 1. Make sure that the repository you’re working on is analyzed by Codacy and that you have a [repository read](../organizations/roles-and-permissions-for-organizations.md) role or higher. !!! tip - If this is your first time using Codacy, see [how to add and analyze your first repository](./codacy-quickstart.md#adding-your-first-repository). + If this is your first time using Codacy, see [how to get started](./codacy-quickstart.md#adding-your-organization-to-codacy). 1. Install the extension from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=codacy-app.codacy) or through the [Extensions view in VS Code](https://code.visualstudio.com/docs/editor/extension-marketplace#_browse-for-extensions). diff --git a/docs/release-notes/cloud/cloud-2023-06.md b/docs/release-notes/cloud/cloud-2023-06.md index b4bbcaaf86..de58e01786 100644 --- a/docs/release-notes/cloud/cloud-2023-06.md +++ b/docs/release-notes/cloud/cloud-2023-06.md @@ -44,7 +44,7 @@ These release notes are for the Codacy Cloud updates during June 2023. - [eslint-plugin-sort-destructure-keys](https://www.npmjs.com/package/eslint-plugin-sort-destructure-keys) (TS-448) - Improved the performance of the tool Stylelint by reviewing and refactoring the tool configurations and supported packages. (TS-438) - Updated and refactored the tool Ameba. [Thanks to Sija for the contribution!](https://github.com/codacy/codacy-ameba/pull/25) (TS-417) -- There's now an onboarding tutorial to guide you through the steps of [adding and setting up your first repository](../../getting-started/codacy-quickstart.md#adding-your-first-repository). (DOCS-468) +- There's now an onboarding tutorial to guide you through the steps of [adding and setting up your first repository](../../getting-started/codacy-quickstart.md#adding-your-organization-to-codacy). (DOCS-468) ## Bug fixes