mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
chore: adopt markdownlint and markdown-table-formatter for *.md (#15831)
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
This commit is contained in:
co-authored by
Edward Angert
parent
08463c27d8
commit
94f5d52fdc
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at opensource@coder.com. All complaints
|
||||
reported by contacting the project team at <opensource@coder.com>. All complaints
|
||||
will be reviewed and investigated and will result in a response that is deemed
|
||||
necessary and appropriate to the circumstances. The project team is obligated to
|
||||
maintain confidentiality with regard to the reporter of an incident. Further
|
||||
@@ -69,9 +69,9 @@ members of the project's leadership.
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 1.4, available at
|
||||
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see
|
||||
https://www.contributor-covenant.org/faq
|
||||
<https://www.contributor-covenant.org/faq>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Security Policy
|
||||
|
||||
If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email to
|
||||
security@coder.com.
|
||||
<security@coder.com>.
|
||||
|
||||
@@ -25,7 +25,7 @@ If you have questions that aren't explicitly covered by this guide, consult the
|
||||
following third-party references:
|
||||
|
||||
| **Type of guidance** | **Third-party reference** |
|
||||
| -------------------- | -------------------------------------------------------------------------------------- |
|
||||
|----------------------|----------------------------------------------------------------------------------------|
|
||||
| Spelling | [Merriam-Webster.com](https://www.merriam-webster.com/) |
|
||||
| Style - nontechnical | [The Chicago Manual of Style](https://www.chicagomanualofstyle.org/home.html) |
|
||||
| Style - technical | [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/) |
|
||||
|
||||
@@ -46,7 +46,7 @@ coder server --experiments=feature1,feature2
|
||||
<!-- BEGIN: available-experimental-features -->
|
||||
|
||||
| Feature | Description | Available in |
|
||||
| --------------- | ------------------------------------------------------------------- | ------------ |
|
||||
|-----------------|---------------------------------------------------------------------|--------------|
|
||||
| `notifications` | Sends notifications via SMTP and webhooks following certain events. | stable |
|
||||
|
||||
<!-- END: available-experimental-features -->
|
||||
|
||||
@@ -129,17 +129,17 @@ within the component's story.
|
||||
|
||||
```tsx
|
||||
export const WithQuota: Story = {
|
||||
parameters: {
|
||||
queries: [
|
||||
{
|
||||
key: getWorkspaceQuotaQueryKey(MockUser.username),
|
||||
data: {
|
||||
credits_consumed: 2,
|
||||
budget: 40,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
parameters: {
|
||||
queries: [
|
||||
{
|
||||
key: getWorkspaceQuotaQueryKey(MockUser.username),
|
||||
data: {
|
||||
credits_consumed: 2,
|
||||
budget: 40,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
@@ -156,12 +156,12 @@ execution. Here's an illustrative example:"
|
||||
|
||||
```ts
|
||||
export const getAgentListeningPorts = async (
|
||||
agentID: string,
|
||||
agentID: string,
|
||||
): Promise<TypesGen.ListeningPortsResponse> => {
|
||||
const response = await axiosInstance.get(
|
||||
`/api/v2/workspaceagents/${agentID}/listening-ports`,
|
||||
);
|
||||
return response.data;
|
||||
const response = await axiosInstance.get(
|
||||
`/api/v2/workspaceagents/${agentID}/listening-ports`,
|
||||
);
|
||||
return response.data;
|
||||
};
|
||||
```
|
||||
|
||||
@@ -170,10 +170,10 @@ as a single function.
|
||||
|
||||
```ts
|
||||
export const updateWorkspaceVersion = async (
|
||||
workspace: TypesGen.Workspace,
|
||||
workspace: TypesGen.Workspace,
|
||||
): Promise<TypesGen.WorkspaceBuild> => {
|
||||
const template = await getTemplate(workspace.template_id);
|
||||
return startWorkspace(workspace.id, template.active_version_id);
|
||||
const template = await getTemplate(workspace.template_id);
|
||||
return startWorkspace(workspace.id, template.active_version_id);
|
||||
};
|
||||
```
|
||||
|
||||
@@ -224,10 +224,10 @@ inside the component itself using MUI's `visuallyHidden` utility function.
|
||||
import { visuallyHidden } from "@mui/utils";
|
||||
|
||||
<Button>
|
||||
<GearIcon />
|
||||
<Box component="span" sx={visuallyHidden}>
|
||||
Settings
|
||||
</Box>
|
||||
<GearIcon />
|
||||
<Box component="span" sx={visuallyHidden}>
|
||||
Settings
|
||||
</Box>
|
||||
</Button>;
|
||||
```
|
||||
|
||||
@@ -332,8 +332,8 @@ One thing we figured out that was slowing down our tests was the use of `ByRole`
|
||||
queries because of how it calculates the role attribute for every element on the
|
||||
`screen`. You can read more about it on the links below:
|
||||
|
||||
- https://stackoverflow.com/questions/69711888/react-testing-library-getbyrole-is-performing-extremely-slowly
|
||||
- https://github.com/testing-library/dom-testing-library/issues/552#issuecomment-625172052
|
||||
- <https://stackoverflow.com/questions/69711888/react-testing-library-getbyrole-is-performing-extremely-slowly>
|
||||
- <https://github.com/testing-library/dom-testing-library/issues/552#issuecomment-625172052>
|
||||
|
||||
Even with `ByRole` having performance issues we still want to use it but for
|
||||
that, we have to scope the "querying" area by using the `within` command. So
|
||||
|
||||
Reference in New Issue
Block a user