Skip to content

Commit f1cca03

Browse files
EdwardAngertEdwardAngert
authored
docs: reorganize the About section (#18236)
As part of an information architecture overhaul, this PR reorganizes the About section and adds a Support section (but not content to it yet) [preview](https://coder.com/docs/@docs-ia-about/about) this PR is intentionally limited in scope so that we can ship meaningful changes faster and followup PRs should include: - [ ] edit + overhaul the About page - [ ] decide on the `start` directory - [ ] ~screenshots page updates~ (this should happen July or later) redirects PR: coder/coder.com#944 --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent 5944b1c commit f1cca03

File tree

19 files changed

+83
-65
lines changed

19 files changed

+83
-65
lines changed

‎CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,4 @@ Read [cursor rules](.cursorrules).
101101

102102
## Frontend
103103

104-
For building Frontend refer to [this document](docs/contributing/frontend.md)
104+
For building Frontend refer to [this document](docs/about/contributing/frontend.md)

‎CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
<!-- markdownlint-disable MD041 -->
2-
[https://coder.com/docs/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT)
2+
[https://coder.com/docs/about/contributing/CODE_OF_CONDUCT](https://coder.com/docs/about/contributing/CODE_OF_CONDUCT)

‎coderd/database/migrations/migrate_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ func TestMigrateUpWithFixtures(t *testing.T) {
283283
if len(emptyTables) > 0 {
284284
t.Log("The following tables have zero rows, consider adding fixtures for them or create a full database dump:")
285285
t.Errorf("tables have zero rows: %v", emptyTables)
286-
t.Log("See https://github.com/coder/coder/blob/main/docs/CONTRIBUTING.md#database-fixtures-for-testing-migrations for more information")
286+
t.Log("See https://github.com/coder/coder/blob/main/docs/about/contributing/backend.md#database-fixtures-for-testing-migrations for more information")
287287
}
288288
})
289289

‎docs/contributing/CODE_OF_CONDUCT.md renamed to ‎docs/about/contributing/CODE_OF_CONDUCT.md

File renamed without changes.

‎docs/CONTRIBUTING.md renamed to ‎docs/about/contributing/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,9 @@ channel.
143143

144144
## Styling
145145

146-
Visit our [documentation style guide](./contributing/documentation.md).
146+
- [Documentation style guide](./documentation.md)
147147

148-
Frontend styling guide can be found [here](./contributing/frontend.md#styling).
148+
- [Frontend styling guide](./frontend.md#styling)
149149

150150
## Reviews
151151

‎docs/about/contributing/SECURITY.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
Coder welcomes feedback from security researchers and the general public to help improve our security.
4+
If you believe you have discovered a vulnerability, privacy issue, exposed data, or other security issues
5+
in any of our assets, we want to hear from you.
6+
7+
If you find a vulnerability, **DO NOT FILE AN ISSUE**.
8+
Instead, send an email to
9+
<security@coder.com>.
10+
11+
Refer to the [Security policy](https://coder.com/security/policy) for more information.

‎docs/contributing/backend.md renamed to ‎docs/about/contributing/backend.md

File renamed without changes.

‎docs/contributing/documentation.md renamed to ‎docs/about/contributing/documentation.md

File renamed without changes.

‎docs/contributing/frontend.md renamed to ‎docs/about/contributing/frontend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ new conventions, but all new components should follow these guidelines.
250250

251251
## Styling
252252

253-
We use [Emotion](https://emotion.sh/) to handle css styles.
253+
We use [Emotion](https://emotion.sh/) to handle CSS styles.
254254

255255
## Forms
256256

‎docs/start/screenshots.md renamed to ‎docs/about/screenshots.md

File renamed without changes.

‎docs/start/why-coder.md renamed to ‎docs/about/why-coder.md

File renamed without changes.

‎docs/admin/security/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ For other security tips, visit our guide to
99

1010
> [!CAUTION]
1111
> If you discover a vulnerability in Coder, please do not hesitate to report it
12-
> to us by following the instructions
13-
> [here](https://github.com/coder/coder/blob/main/SECURITY.md).
12+
> to us by following the [security policy](https://github.com/coder/coder/blob/main/SECURITY.md).
1413
1514
From time to time, Coder employees or other community members may discover
1615
vulnerabilities in the product.

‎docs/admin/templates/extending-templates/modules.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@ For a full list of available modules please check
5454

5555
## Offline installations
5656

57-
In offline and restricted deploymnets, there are 2 ways to fetch modules.
57+
In offline and restricted deployments, there are two ways to fetch modules.
5858

5959
1. Artifactory
6060
2. Private git repository
6161

6262
### Artifactory
6363

64-
Air gapped users can clone the [coder/modules](https://github.com/coder/modules)
64+
Air gapped users can clone the [coder/registry](https://github.com/coder/registry/)
6565
repo and publish a
6666
[local terraform module repository](https://jfrog.com/help/r/jfrog-artifactory-documentation/set-up-a-terraform-module/provider-registry)
6767
to resolve modules via [Artifactory](https://jfrog.com/artifactory/).
@@ -71,8 +71,8 @@ to resolve modules via [Artifactory](https://jfrog.com/artifactory/).
7171
3. Follow the below instructions to publish coder modules to Artifactory
7272

7373
```shell
74-
git clone https://github.com/coder/modules
75-
cd modules
74+
git clone https://github.com/coder/registry
75+
cd registry/coder/modules
7676
jf tfc
7777
jf tf p --namespace="coder" --provider="coder" --tag="1.0.0"
7878
```

‎docs/ai-coder/custom-agents.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ any-custom-agent configure-mcp --name "coder" --command "coder exp mcp server"
4040

4141
This will start the MCP server and report activity back to the Coder control plane on behalf of the coder_app resource.
4242

43-
> See the [Goose module](https://github.com/coder/modules/blob/main/goose/main.tf) source code for a real world example.
43+
> See the [Goose module](https://github.com/coder/registry/blob/main/registry/coder/modules/goose/main.tf) source code for a real world example.
4444
4545
## Contributing
4646

4747
We welcome contributions for various agents via the [Coder registry](https://registry.coder.com/modules?tag=agent)!
4848

49-
See our [contributing guide](https://github.com/coder/modules/blob/main/CONTRIBUTING.md) for more information.
49+
See our [contributing guide](https://github.com/coder/registry/blob/main/CONTRIBUTING.md) for more information.

‎docs/contributing/SECURITY.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎docs/manifest.json

Lines changed: 53 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,65 @@
77
"path": "./README.md",
88
"icon_path": "./images/icons/home.svg",
99
"children": [
10+
{
11+
"title": "Screenshots",
12+
"description": "View screenshots of the Coder platform",
13+
"path": "./about/screenshots.md"
14+
},
1015
{
1116
"title": "Quickstart",
1217
"description": "Learn how to install and run Coder quickly",
1318
"path": "./tutorials/quickstart.md"
1419
},
1520
{
16-
"title": "Screenshots",
17-
"description": "View screenshots of the Coder platform",
18-
"path": "./start/screenshots.md"
21+
"title": "Support",
22+
"description": "How Coder supports your deployment and you",
23+
"path": "./support/index.md",
24+
"children": [
25+
{
26+
"title": "Generate a Support Bundle",
27+
"description": "Generate and upload a Support Bundle to Coder Support",
28+
"path": "./support/support-bundle.md"
29+
}
30+
]
31+
},
32+
{
33+
"title": "Contributing",
34+
"description": "Learn how to contribute to Coder",
35+
"path": "./about/contributing/CONTRIBUTING.md",
36+
"icon_path": "./images/icons/contributing.svg",
37+
"children": [
38+
{
39+
"title": "Code of Conduct",
40+
"description": "See the code of conduct for contributing to Coder",
41+
"path": "./about/contributing/CODE_OF_CONDUCT.md",
42+
"icon_path": "./images/icons/circle-dot.svg"
43+
},
44+
{
45+
"title": "Documentation",
46+
"description": "Our style guide for use when authoring documentation",
47+
"path": "./about/contributing/documentation.md",
48+
"icon_path": "./images/icons/document.svg"
49+
},
50+
{
51+
"title": "Backend",
52+
"description": "Our guide for backend development",
53+
"path": "./about/contributing/backend.md",
54+
"icon_path": "./images/icons/gear.svg"
55+
},
56+
{
57+
"title": "Frontend",
58+
"description": "Our guide for frontend development",
59+
"path": "./about/contributing/frontend.md",
60+
"icon_path": "./images/icons/frontend.svg"
61+
},
62+
{
63+
"title": "Security",
64+
"description": "Security vulnerability disclosure policy",
65+
"path": "./about/contributing/SECURITY.md",
66+
"icon_path": "./images/icons/lock.svg"
67+
}
68+
]
1969
}
2070
]
2171
},
@@ -810,44 +860,6 @@
810860
}
811861
]
812862
},
813-
{
814-
"title": "Contributing",
815-
"description": "Learn how to contribute to Coder",
816-
"path": "./CONTRIBUTING.md",
817-
"icon_path": "./images/icons/contributing.svg",
818-
"children": [
819-
{
820-
"title": "Code of Conduct",
821-
"description": "See the code of conduct for contributing to Coder",
822-
"path": "./contributing/CODE_OF_CONDUCT.md",
823-
"icon_path": "./images/icons/circle-dot.svg"
824-
},
825-
{
826-
"title": "Documentation",
827-
"description": "Our style guide for use when authoring documentation",
828-
"path": "./contributing/documentation.md",
829-
"icon_path": "./images/icons/document.svg"
830-
},
831-
{
832-
"title": "Backend",
833-
"description": "Our guide for backend development",
834-
"path": "./contributing/backend.md",
835-
"icon_path": "./images/icons/gear.svg"
836-
},
837-
{
838-
"title": "Frontend",
839-
"description": "Our guide for frontend development",
840-
"path": "./contributing/frontend.md",
841-
"icon_path": "./images/icons/frontend.svg"
842-
},
843-
{
844-
"title": "Security",
845-
"description": "Our guide for security",
846-
"path": "./contributing/SECURITY.md",
847-
"icon_path": "./images/icons/lock.svg"
848-
}
849-
]
850-
},
851863
{
852864
"title": "Tutorials",
853865
"description": "Coder knowledgebase for administrating your deployment",
@@ -874,11 +886,6 @@
874886
"description": "Learn about image management with Coder",
875887
"path": "./admin/templates/managing-templates/image-management.md"
876888
},
877-
{
878-
"title": "Generate a Support Bundle",
879-
"description": "Generate and upload a Support Bundle to Coder Support",
880-
"path": "./tutorials/support-bundle.md"
881-
},
882889
{
883890
"title": "Configuring Okta",
884891
"description": "Custom claims/scopes with Okta for group/role sync",

‎docs/support/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Support
2+
3+
If you have questions, encounter an issue or bug, or if you have a feature request, [open a GitHub issue](https://github.com/coder/coder/issues/new) or [join our Discord](https://discord.gg/coder).
4+
5+
<children></children>

‎docs/tutorials/support-bundle.md renamed to ‎docs/support/support-bundle.md

File renamed without changes.

‎docs/user-guides/workspace-access/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Supported IDEs:
140140
Our [Module Registry](https://registry.coder.com/modules) also hosts a variety
141141
of tools for extending the capability of your workspace. If you have a request
142142
for a new IDE or tool, please file an issue in our
143-
[Modules repo](https://github.com/coder/modules/issues).
143+
[Modules repo](https://github.com/coder/registry/issues).
144144

145145
## Ports and Port forwarding
146146

0 commit comments

Comments
 (0)