Skip to content

Commit acbee31

Browse files
nicklemPaulo Ribeiro
andauthored
feat: Multi-step indicator DOCS-470 (#1606)
* feat: Nav multistep * feat: Add multistep navigation to the quickstart flow * wip: Update codacy-mkdocs-material submodule * feat: Improve styling * feat: Update codacy-mkdocs-material * feat: Update codacy-mkdocs-material * feat: Nav multistep quickstart naming * feat: Update codacy-mkdocs-material * feat: Introduce multistep navigation * feat: Update codacy-mkdocs-material * feat: Update codacy-mkdocs-material * feat: Update codacy-mkdocs-material --------- Co-authored-by: Paulo Ribeiro <[email protected]>
1 parent ec5d871 commit acbee31

File tree

4 files changed

+52
-2
lines changed

4 files changed

+52
-2
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<nav class="nav-multistep">
2+
<p>This page is part of the following guided path:</p>
3+
<ol>
4+
<li class="{% if page.meta.nav_step == 0 %}nav-multistep__step--active{% endif %}">
5+
{% if page.meta.nav_step == 0 %}
6+
<p>
7+
Adding your first repository
8+
</p>
9+
{% else %}
10+
<a href="/getting-started/codacy-quickstart#adding-your-first-repository">
11+
Adding your first repository
12+
</a>
13+
{% endif %}
14+
</li>
15+
<li class="{% if page.meta.nav_step == 1 %}nav-multistep__step--active{% endif %}">
16+
{% if page.meta.nav_step == 1 %}
17+
<p>
18+
Configuring your repository
19+
</p>
20+
{% else %}
21+
<a href="/getting-started/configuring-your-repository#configuring-your-repository">
22+
Configuring your repository
23+
</a>
24+
{% endif %}
25+
</li>
26+
<li class="{% if page.meta.nav_step == 2 %}nav-multistep__step--active{% endif %}">
27+
{% if page.meta.nav_step == 2 %}
28+
<p>
29+
Integrating Codacy with your Git workflow
30+
</p>
31+
{% else %}
32+
<a href="/getting-started/integrating-codacy-with-your-git-workflow#integrating-codacy-with-your-git-workflow">
33+
Integrating Codacy with your Git workflow
34+
</a>
35+
{% endif %}
36+
</li>
37+
</ol>
38+
</nav>
39+

docs/getting-started/codacy-quickstart.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
description: Set up Codacy to automatically analyze your source code and identify issues as you go, helping you develop software more efficiently with fewer issues down the line. Codacy notifies you of security issues, code coverage, duplication, and complexity in every commit and pull request.
3+
nav_step: 0
34
---
45

56
# Codacy quickstart (5 min)
@@ -17,6 +18,10 @@ By integrating with your Git provider, Codacy keeps track of your team’s work,
1718
- **Duplication**: the amount of duplicated portions of code
1819
- **Coverage**: the percentage of lines of code covered by automated tests
1920

21+
## Adding your first repository
22+
23+
{% include-markdown "../assets/includes/nav-multistep-quickstart.md" %}
24+
2025
To get started, head to [<span class="skip-vale">codacy.com</span>](https://www.codacy.com/) and click **Get started**. Then, follow these steps:
2126

2227
1. [Signing up](#signing-up)

docs/getting-started/configuring-your-repository.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
---
22
description: Configure Codacy to match the coding conventions and best practices that your team may already be following or that you want to promote.
3+
nav_step: 1
34
---
45

56
# Configuring your repository
67

7-
Once you've [added your first repository](codacy-quickstart.md), 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.
8+
{% include-markdown "../assets/includes/nav-multistep-quickstart.md" %}
9+
10+
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.
811

912
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.
1013

docs/getting-started/integrating-codacy-with-your-git-workflow.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
---
22
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.
3+
nav_step: 2
34
---
45

56
# Integrating Codacy with your Git workflow
67

7-
Once you've [configured your repository](configuring-your-repository.md) to best match your use case, integrate Codacy with your Git workflow to display analysis results and code coverage as status checks on your pull requests.
8+
{% include-markdown "../assets/includes/nav-multistep-quickstart.md" %}
9+
10+
Once you've configured your repository to best match your use case, integrate Codacy with your Git workflow to display analysis results and code coverage as status checks on your pull requests.
811

912
In particular, you can configure quality gates to block merging pull requests that don't meet the quality standards of your team. This ensures the quality of the changes to your codebase, preventing the introduction of security issues and untested code.
1013

0 commit comments

Comments
 (0)