Skip to content

Commit 10c2243

Browse files
claudiacodacyclaudiacodacy
committed
5 million changes
1 parent ec8e09d commit 10c2243

File tree

575 files changed

+26538
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

575 files changed

+26538
-2
lines changed

‎docs/getting-started/codacy-quickstart.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ To get started, head to [<span class="skip-vale">codacy.com</span>](https://www.
2828
1. [Choosing an organization](#choosing-organization)
2929
1. [Adding repositories](#adding-repositories)
3030

31-
## 1. Signing up {: id="signing-up"}
31+
## 1. Signing up {: #signing-up}
3232

3333
Sign up with a Git provider such as GitHub, GitLab, or Bitbucket. This links your Codacy user with your Git provider user, making it easier to add repositories to Codacy and invite your teammates.
3434

3535
Codacy will request access to your Git provider during the authorization flow. [Check the permissions that Codacy requires and why](which-permissions-does-codacy-need-from-my-account.md).
3636

37-
## 2. Choosing an organization {: id="choosing-organization"}
37+
## 2. Choosing an organization {: #choosing-organization}
3838

3939
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).
4040

‎new-docs/.gitignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store

‎new-docs/README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Starlight Starter Kit: Basics
2+
3+
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
4+
5+
```
6+
npm create astro@latest -- --template starlight
7+
```
8+
9+
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
10+
11+
## 🚀 Project Structure
12+
13+
Inside of your Astro + Starlight project, you'll see the following folders and files:
14+
15+
```
16+
.
17+
├── public/
18+
├── src/
19+
│ ├── assets/
20+
│ ├── content/
21+
│ │ └── docs/
22+
│ └── content.config.ts
23+
├── astro.config.mjs
24+
├── package.json
25+
└── tsconfig.json
26+
```
27+
28+
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
29+
30+
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
31+
32+
Static assets, like favicons, can be placed in the `public/` directory.
33+
34+
## 🧞 Commands
35+
36+
All commands are run from the root of the project, from a terminal:
37+
38+
| Command | Action |
39+
| :------------------------ | :----------------------------------------------- |
40+
| `npm install` | Installs dependencies |
41+
| `npm run dev` | Starts local dev server at `localhost:4321` |
42+
| `npm run build` | Build your production site to `./dist/` |
43+
| `npm run preview` | Preview your build locally, before deploying |
44+
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
45+
| `npm run astro -- --help` | Get help using the Astro CLI |
46+
47+
## 👀 Want to learn more?
48+
49+
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

‎new-docs/astro.config.mjs‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
// @ts-check
2+
import { defineConfig } from 'astro/config';
3+
import starlight from '@astrojs/starlight';
4+
import remarkAttrs from 'remark-attrs';
5+
import remarkKramdownAttrs from './src/remark/kramdown-attrs.mjs';
6+
7+
// https://astro.build/config
8+
export default defineConfig({
9+
markdown: {
10+
remarkPlugins: [remarkKramdownAttrs, remarkAttrs],
11+
},
12+
integrations: [
13+
starlight({
14+
title: 'Codacy',
15+
customCss: ['./src/styles/theme.css'],
16+
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/codacy/docs' }],
17+
sidebar: [
18+
{
19+
label: 'Getting started',
20+
items: [
21+
{ label: 'Codacy quickstart', slug: 'getting-started/codacy-quickstart' },
22+
{ label: 'Configuring your repository', slug: 'getting-started/configuring-your-repository' },
23+
{
24+
label: 'Integrating Codacy with your Git workflow',
25+
slug: 'getting-started/integrating-codacy-with-your-git-workflow',
26+
},
27+
{
28+
label: 'Integrating Codacy with your IDE',
29+
items: [
30+
{
31+
label: 'Integrating Codacy with IntelliJ IDEs',
32+
slug: 'getting-started/integrating-codacy-with-intellij-ides',
33+
},
34+
{
35+
label: 'Integrating Codacy with Visual Studio Code',
36+
slug: 'getting-started/integrating-codacy-with-visual-studio-code',
37+
},
38+
],
39+
},
40+
{ label: 'Supported languages and tools', slug: 'getting-started/supported-languages-and-tools' },
41+
{
42+
label: 'Which permissions does Codacy need from my account?',
43+
slug: 'getting-started/which-permissions-does-codacy-need-from-my-account',
44+
},
45+
{ label: 'Adding a Codacy badge', slug: 'getting-started/adding-a-codacy-badge' },
46+
],
47+
},
48+
{
49+
label: 'Codacy Guardrails (IDE Extension)',
50+
autogenerate: { directory: 'codacy-guardrails' },
51+
},
52+
{
53+
label: 'Codacy AI',
54+
autogenerate: { directory: 'codacy-ai' },
55+
},
56+
{
57+
label: 'Repositories on Codacy',
58+
autogenerate: { directory: 'repositories' },
59+
},
60+
{
61+
label: 'Configuring your repositories',
62+
items: [
63+
{ label: 'Configuring code patterns', slug: 'repositories-configure/configuring-code-patterns' },
64+
{ label: 'Managing branches', slug: 'repositories-configure/managing-branches' },
65+
{
66+
label: 'Managing integrations',
67+
autogenerate: { directory: 'repositories-configure/integrations' },
68+
},
69+
{ label: 'Ignoring files', slug: 'repositories-configure/ignoring-files' },
70+
{ label: 'Languages', slug: 'repositories-configure/languages' },
71+
{ label: 'Adjusting quality gates', slug: 'repositories-configure/adjusting-quality-gates' },
72+
{ label: 'Adjusting quality goals', slug: 'repositories-configure/adjusting-quality-goals' },
73+
{
74+
label: 'Setting up code coverage',
75+
autogenerate: { directory: 'coverage-reporter' },
76+
},
77+
{
78+
label: 'Local analysis',
79+
autogenerate: { directory: 'repositories-configure/local-analysis' },
80+
},
81+
{ label: 'Using submodules', slug: 'repositories-configure/using-submodules' },
82+
{
83+
label: 'Codacy configuration file',
84+
slug: 'repositories-configure/codacy-configuration-file',
85+
},
86+
{ label: 'Removing your repository', slug: 'repositories-configure/removing-your-repository' },
87+
],
88+
},
89+
{
90+
label: 'Organizations',
91+
items: [
92+
{ label: 'What are organizations?', slug: 'organizations/what-are-organizations' },
93+
{ label: 'Organization overview', slug: 'organizations/organization-overview' },
94+
{ label: 'Managing repositories', slug: 'organizations/managing-repositories' },
95+
{ label: 'Segments', slug: 'organizations/segments' },
96+
{ label: 'Issues metrics', slug: 'organizations/issues-metrics' },
97+
{ label: 'AI Risk Hub', slug: 'organizations/ai-risk-hub' },
98+
{ label: 'Using gate policies', slug: 'organizations/using-gate-policies' },
99+
{ label: 'Using coding standards', slug: 'organizations/using-coding-standards' },
100+
{
101+
label: 'Managing integrations',
102+
items: [
103+
{
104+
label: 'Default Git provider integration settings',
105+
slug: 'organizations/integrations/default-git-provider-integration-settings',
106+
},
107+
{
108+
label: 'Slack integration for Security issues',
109+
slug: 'organizations/integrations/slack-integration',
110+
},
111+
{
112+
label: 'Jira integration for Security and risk management',
113+
slug: 'organizations/integrations/jira-integration',
114+
},
115+
],
116+
},
117+
{ label: 'Managing security and risk', slug: 'organizations/managing-security-and-risk' },
118+
{ label: 'Managing people', slug: 'organizations/managing-people' },
119+
{ label: 'Audit logs for organizations', slug: 'organizations/audit-logs-for-organizations' },
120+
{
121+
label: 'Roles and permissions for organizations',
122+
slug: 'organizations/roles-and-permissions-for-organizations',
123+
},
124+
{ label: 'Changing your plan and billing', slug: 'organizations/changing-your-plan-and-billing' },
125+
],
126+
},
127+
{
128+
label: 'Enterprise Cloud',
129+
autogenerate: { directory: 'enterprise-cloud' },
130+
},
131+
{
132+
label: 'Your account',
133+
autogenerate: { directory: 'account' },
134+
},
135+
{
136+
label: 'Codacy API',
137+
items: [
138+
{ label: 'Using the Codacy API', slug: 'codacy-api/using-the-codacy-api' },
139+
{ label: 'API tokens', slug: 'codacy-api/api-tokens' },
140+
{ label: 'API v3 reference (recommended)', link: 'https://api.codacy.com/api/api-docs' },
141+
{ label: 'API v2 reference', link: 'https://api.codacy.com/api-docs' },
142+
{
143+
label: 'Examples',
144+
autogenerate: { directory: 'codacy-api/examples' },
145+
},
146+
],
147+
},
148+
{
149+
label: 'Troubleshooting and FAQs',
150+
items: [
151+
{ label: 'General', autogenerate: { directory: 'faq/general' } },
152+
{ label: 'Repositories', autogenerate: { directory: 'faq/repositories' } },
153+
{ label: 'Code analysis', autogenerate: { directory: 'faq/code-analysis' } },
154+
{ label: 'Troubleshooting', autogenerate: { directory: 'faq/troubleshooting' } },
155+
],
156+
},
157+
{
158+
label: 'Release notes',
159+
items: [
160+
{ label: 'Overview', slug: 'release-notes' },
161+
{ label: 'Cloud', autogenerate: { directory: 'release-notes/cloud' } },
162+
{ label: 'Self-hosted', autogenerate: { directory: 'release-notes/self-hosted' } },
163+
],
164+
},
165+
{
166+
label: 'Special thanks',
167+
slug: 'special-thanks',
168+
},
169+
],
170+
}),
171+
],
172+
});

0 commit comments

Comments
 (0)