Skip to content

Commit d37f6d8

Browse files
matifalimatifali
authored
chore(docs): update docs for correct use of shell and console and enforce linewidth (#9245)
1 parent ed2b123 commit d37f6d8

Some content is hidden

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

96 files changed

+2856
-1475
lines changed

‎.prettierrc.yaml

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
# formatting for prettier-supported files. See `.editorconfig` and
33
# `site/.editorconfig`for whitespace formatting options.
44
printWidth: 80
5+
proseWrap: always
56
semi: false
67
trailingComma: all
78
useTabs: false
89
tabWidth: 2
910
overrides:
1011
- files:
1112
- README.md
13+
- docs/api/**/*.md
14+
- docs/cli/**/*.md
15+
- .github/**/*.{yaml,yml,toml}
16+
- scripts/**/*.{yaml,yml,toml}
1217
options:
1318
proseWrap: preserve
14-
- files:
15-
- "site/**/*.yaml"
16-
- "site/**/*.yml"
17-
options:
18-
proseWrap: always

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ You can run the install script with `--dry-run` to see the commands that will be
7474
7575
Once installed, you can start a production deployment<sup>1</sup> with a single command:
7676

77-
```console
77+
```shell
7878
# Automatically sets up an external access URL on *.try.coder.app
7979
coder server
8080

‎SECURITY.md

+47-39
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Coder Security
22

3-
Coder welcomes feedback from security researchers and the general public
4-
to help improve our security. If you believe you have discovered a vulnerability,
3+
Coder welcomes feedback from security researchers and the general public to help
4+
improve our security. If you believe you have discovered a vulnerability,
55
privacy issue, exposed data, or other security issues in any of our assets, we
66
want to hear from you. This policy outlines steps for reporting vulnerabilities
77
to us, what we expect, what you can expect from us.
@@ -10,64 +10,72 @@ You can see the pretty version [here](https://coder.com/security/policy)
1010

1111
# Why Coder's security matters
1212

13-
If an attacker could fully compromise a Coder installation, they could spin
14-
up expensive workstations, steal valuable credentials, or steal proprietary
15-
source code. We take this risk very seriously and employ routine pen testing,
16-
vulnerability scanning, and code reviews. We also welcome the contributions
17-
from the community that helped make this product possible.
13+
If an attacker could fully compromise a Coder installation, they could spin up
14+
expensive workstations, steal valuable credentials, or steal proprietary source
15+
code. We take this risk very seriously and employ routine pen testing,
16+
vulnerability scanning, and code reviews. We also welcome the contributions from
17+
the community that helped make this product possible.
1818

1919
# Where should I report security issues?
2020

21-
Please report security issues to security@coder.com, providing
22-
all relevant information. The more details you provide, the easier it will be
23-
for us to triage and fix the issue.
21+
Please report security issues to security@coder.com, providing all relevant
22+
information. The more details you provide, the easier it will be for us to
23+
triage and fix the issue.
2424

2525
# Out of Scope
2626

27-
Our primary concern is around an abuse of the Coder application that allows
28-
an attacker to gain access to another users workspace, or spin up unwanted
27+
Our primary concern is around an abuse of the Coder application that allows an
28+
attacker to gain access to another users workspace, or spin up unwanted
2929
workspaces.
3030

3131
- DOS/DDOS attacks affecting availability --> While we do support rate limiting
32-
of requests, we primarily leave this to the owner of the Coder installation. Our
33-
rationale is that a DOS attack only affecting availability is not a valuable
34-
target for attackers.
32+
of requests, we primarily leave this to the owner of the Coder installation.
33+
Our rationale is that a DOS attack only affecting availability is not a
34+
valuable target for attackers.
3535
- Abuse of a compromised user credential --> If a user credential is compromised
36-
outside of the Coder ecosystem, then we consider it beyond the scope of our application.
37-
However, if an unprivileged user could escalate their permissions or gain access
38-
to another workspace, that is a cause for concern.
36+
outside of the Coder ecosystem, then we consider it beyond the scope of our
37+
application. However, if an unprivileged user could escalate their permissions
38+
or gain access to another workspace, that is a cause for concern.
3939
- Vulnerabilities in third party systems --> Vulnerabilities discovered in
40-
out-of-scope systems should be reported to the appropriate vendor or applicable authority.
40+
out-of-scope systems should be reported to the appropriate vendor or
41+
applicable authority.
4142

4243
# Our Commitments
4344

4445
When working with us, according to this policy, you can expect us to:
4546

46-
- Respond to your report promptly, and work with you to understand and validate your report;
47-
- Strive to keep you informed about the progress of a vulnerability as it is processed;
48-
- Work to remediate discovered vulnerabilities in a timely manner, within our operational constraints; and
49-
- Extend Safe Harbor for your vulnerability research that is related to this policy.
47+
- Respond to your report promptly, and work with you to understand and validate
48+
your report;
49+
- Strive to keep you informed about the progress of a vulnerability as it is
50+
processed;
51+
- Work to remediate discovered vulnerabilities in a timely manner, within our
52+
operational constraints; and
53+
- Extend Safe Harbor for your vulnerability research that is related to this
54+
policy.
5055

5156
# Our Expectations
5257

53-
In participating in our vulnerability disclosure program in good faith, we ask that you:
58+
In participating in our vulnerability disclosure program in good faith, we ask
59+
that you:
5460

55-
- Play by the rules, including following this policy and any other relevant agreements.
56-
If there is any inconsistency between this policy and any other applicable terms, the
57-
terms of this policy will prevail;
61+
- Play by the rules, including following this policy and any other relevant
62+
agreements. If there is any inconsistency between this policy and any other
63+
applicable terms, the terms of this policy will prevail;
5864
- Report any vulnerability you’ve discovered promptly;
59-
- Avoid violating the privacy of others, disrupting our systems, destroying data, and/or
60-
harming user experience;
65+
- Avoid violating the privacy of others, disrupting our systems, destroying
66+
data, and/or harming user experience;
6167
- Use only the Official Channels to discuss vulnerability information with us;
62-
- Provide us a reasonable amount of time (at least 90 days from the initial report) to
63-
resolve the issue before you disclose it publicly;
64-
- Perform testing only on in-scope systems, and respect systems and activities which
65-
are out-of-scope;
66-
- If a vulnerability provides unintended access to data: Limit the amount of data you
67-
access to the minimum required for effectively demonstrating a Proof of Concept; and
68-
cease testing and submit a report immediately if you encounter any user data during testing,
69-
such as Personally Identifiable Information (PII), Personal Healthcare Information (PHI),
70-
credit card data, or proprietary information;
71-
- You should only interact with test accounts you own or with explicit permission from
68+
- Provide us a reasonable amount of time (at least 90 days from the initial
69+
report) to resolve the issue before you disclose it publicly;
70+
- Perform testing only on in-scope systems, and respect systems and activities
71+
which are out-of-scope;
72+
- If a vulnerability provides unintended access to data: Limit the amount of
73+
data you access to the minimum required for effectively demonstrating a Proof
74+
of Concept; and cease testing and submit a report immediately if you encounter
75+
any user data during testing, such as Personally Identifiable Information
76+
(PII), Personal Healthcare Information (PHI), credit card data, or proprietary
77+
information;
78+
- You should only interact with test accounts you own or with explicit
79+
permission from
7280
- the account holder; and
7381
- Do not engage in extortion.

0 commit comments

Comments
 (0)