Skip to content

Commit e202ba2

Browse files
committed
fixed imports + all mdx / md formatting
1 parent ea31ee5 commit e202ba2

139 files changed

Lines changed: 1140 additions & 969 deletions

File tree

Some content is hidden

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

docusaurus/docs/_includes/AdminAccessControlInfo.astro

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import Admonition from '@theme/Admonition';
2+
3+
export default function AdminAccessControlInfo() {
4+
return (
5+
<Admonition type="note">
6+
<p>
7+
Organization admins can{' '}
8+
<a href="/organizations/roles-and-permissions-for-organizations#change-analysis-configuration">
9+
manage access to this feature
10+
</a>
11+
.
12+
</p>
13+
</Admonition>
14+
);
15+
}

docusaurus/docs/_includes/AdminAccessInfo.astro

Lines changed: 0 additions & 8 deletions
This file was deleted.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import Admonition from '@theme/Admonition';
2+
3+
export default function AdminAccessInfo() {
4+
return (
5+
<Admonition type="note">
6+
<p>Only organization admins can update this setting.</p>
7+
</Admonition>
8+
);
9+
}

docusaurus/docs/_includes/AiInfo.astro

Lines changed: 0 additions & 18 deletions
This file was deleted.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import Admonition from '@theme/Admonition';
2+
3+
export default function AiInfo() {
4+
return (
5+
<Admonition type="note">
6+
<ul>
7+
<li>
8+
This feature is compatible with most programming languages and requires
9+
no additional setup.
10+
</li>
11+
<li>
12+
Comments are generated using the description of the static analysis
13+
issue, information about the tool that detected the issue, and a few
14+
lines of surrounding code to provide the AI with extra context and
15+
improve its accuracy.
16+
</li>
17+
<li>
18+
This feature leverages the OpenAI API. No information is shared with
19+
other third parties or used to train AI models. Refer to the{' '}
20+
<a href="https://openai.com/policies/api-data-usage-policies">
21+
OpenAI API data usage policies
22+
</a>{' '}
23+
for more information.
24+
</li>
25+
</ul>
26+
</Admonition>
27+
);
28+
}

docusaurus/docs/_includes/ApiExamplePaginationImportant.astro

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import Admonition from '@theme/Admonition';
2+
3+
export default function ApiExamplePaginationImportant({ github = false }) {
4+
return (
5+
<Admonition type="caution">
6+
<p>
7+
For the sake of simplicity, the example doesn't consider paginated
8+
results obtained from the Codacy API.{' '}
9+
<a href="/codacy-api/using-the-codacy-api#using-pagination">
10+
Learn how to use pagination
11+
</a>{' '}
12+
to ensure that you process all results returned by the API.
13+
</p>
14+
{github && (
15+
<p>
16+
Besides this, the script doesn’t consider paginated results obtained
17+
from the GitHub API.{' '}
18+
<a href="https://docs.github.com/en/rest/using-the-rest-api/using-pagination-in-the-rest-api">
19+
Learn how to use pagination on the GitHub API
20+
</a>{' '}
21+
to ensure that you obtain all the repositories in your organization.
22+
</p>
23+
)}
24+
</Admonition>
25+
);
26+
}

docusaurus/docs/_includes/ApiTokenWarning.astro

Lines changed: 0 additions & 8 deletions
This file was deleted.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import Admonition from '@theme/Admonition';
2+
3+
export default function ApiTokenWarning() {
4+
return (
5+
<Admonition type="caution">
6+
<p>
7+
<strong>Never write API tokens to your configuration files</strong> and
8+
keep your API tokens well protected, as they grant owner permissions to
9+
your projects on Codacy.
10+
</p>
11+
<p>
12+
It's a best practice to store API tokens as environment variables. Check
13+
the documentation of your CI/CD platform on how to do this.
14+
</p>
15+
</Admonition>
16+
);
17+
}

0 commit comments

Comments
 (0)