mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
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: https://github.com/coder/coder.com/pull/944 --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
This commit is contained in:
Edward Angert
GitHub
@ -101,4 +101,4 @@ Read [cursor rules](.cursorrules).
|
||||
|
||||
## Frontend
|
||||
|
||||
For building Frontend refer to [this document](docs/contributing/frontend.md)
|
||||
For building Frontend refer to [this document](docs/about/contributing/frontend.md)
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
<!-- markdownlint-disable MD041 -->
|
||||
[https://coder.com/docs/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT)
|
||||
[https://coder.com/docs/about/contributing/CODE_OF_CONDUCT](https://coder.com/docs/about/contributing/CODE_OF_CONDUCT)
|
||||
|
||||
@ -283,7 +283,7 @@ func TestMigrateUpWithFixtures(t *testing.T) {
|
||||
if len(emptyTables) > 0 {
|
||||
t.Log("The following tables have zero rows, consider adding fixtures for them or create a full database dump:")
|
||||
t.Errorf("tables have zero rows: %v", emptyTables)
|
||||
t.Log("See https://github.com/coder/coder/blob/main/docs/CONTRIBUTING.md#database-fixtures-for-testing-migrations for more information")
|
||||
t.Log("See https://github.com/coder/coder/blob/main/docs/about/contributing/backend.md#database-fixtures-for-testing-migrations for more information")
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
@ -143,9 +143,9 @@ channel.
|
||||
|
||||
## Styling
|
||||
|
||||
Visit our [documentation style guide](./contributing/documentation.md).
|
||||
- [Documentation style guide](./documentation.md)
|
||||
|
||||
Frontend styling guide can be found [here](./contributing/frontend.md#styling).
|
||||
- [Frontend styling guide](./frontend.md#styling)
|
||||
|
||||
## Reviews
|
||||
|
||||
11
docs/about/contributing/SECURITY.md
Normal file
11
docs/about/contributing/SECURITY.md
Normal file
@ -0,0 +1,11 @@
|
||||
# Security Policy
|
||||
|
||||
Coder welcomes feedback from security researchers and the general public to help improve our security.
|
||||
If you believe you have discovered a vulnerability, privacy issue, exposed data, or other security issues
|
||||
in any of our assets, we want to hear from you.
|
||||
|
||||
If you find a vulnerability, **DO NOT FILE AN ISSUE**.
|
||||
Instead, send an email to
|
||||
<security@coder.com>.
|
||||
|
||||
Refer to the [Security policy](https://coder.com/security/policy) for more information.
|
||||
@ -250,7 +250,7 @@ new conventions, but all new components should follow these guidelines.
|
||||
|
||||
## Styling
|
||||
|
||||
We use [Emotion](https://emotion.sh/) to handle css styles.
|
||||
We use [Emotion](https://emotion.sh/) to handle CSS styles.
|
||||
|
||||
## Forms
|
||||
|
||||
@ -9,8 +9,7 @@ For other security tips, visit our guide to
|
||||
|
||||
> [!CAUTION]
|
||||
> If you discover a vulnerability in Coder, please do not hesitate to report it
|
||||
> to us by following the instructions
|
||||
> [here](https://github.com/coder/coder/blob/main/SECURITY.md).
|
||||
> to us by following the [security policy](https://github.com/coder/coder/blob/main/SECURITY.md).
|
||||
|
||||
From time to time, Coder employees or other community members may discover
|
||||
vulnerabilities in the product.
|
||||
|
||||
@ -54,14 +54,14 @@ For a full list of available modules please check
|
||||
|
||||
## Offline installations
|
||||
|
||||
In offline and restricted deploymnets, there are 2 ways to fetch modules.
|
||||
In offline and restricted deployments, there are two ways to fetch modules.
|
||||
|
||||
1. Artifactory
|
||||
2. Private git repository
|
||||
|
||||
### Artifactory
|
||||
|
||||
Air gapped users can clone the [coder/modules](https://github.com/coder/modules)
|
||||
Air gapped users can clone the [coder/registry](https://github.com/coder/registry/)
|
||||
repo and publish a
|
||||
[local terraform module repository](https://jfrog.com/help/r/jfrog-artifactory-documentation/set-up-a-terraform-module/provider-registry)
|
||||
to resolve modules via [Artifactory](https://jfrog.com/artifactory/).
|
||||
@ -71,8 +71,8 @@ to resolve modules via [Artifactory](https://jfrog.com/artifactory/).
|
||||
3. Follow the below instructions to publish coder modules to Artifactory
|
||||
|
||||
```shell
|
||||
git clone https://github.com/coder/modules
|
||||
cd modules
|
||||
git clone https://github.com/coder/registry
|
||||
cd registry/coder/modules
|
||||
jf tfc
|
||||
jf tf p --namespace="coder" --provider="coder" --tag="1.0.0"
|
||||
```
|
||||
|
||||
@ -40,10 +40,10 @@ any-custom-agent configure-mcp --name "coder" --command "coder exp mcp server"
|
||||
|
||||
This will start the MCP server and report activity back to the Coder control plane on behalf of the coder_app resource.
|
||||
|
||||
> See the [Goose module](https://github.com/coder/modules/blob/main/goose/main.tf) source code for a real world example.
|
||||
> See the [Goose module](https://github.com/coder/registry/blob/main/registry/coder/modules/goose/main.tf) source code for a real world example.
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions for various agents via the [Coder registry](https://registry.coder.com/modules?tag=agent)!
|
||||
|
||||
See our [contributing guide](https://github.com/coder/modules/blob/main/CONTRIBUTING.md) for more information.
|
||||
See our [contributing guide](https://github.com/coder/registry/blob/main/CONTRIBUTING.md) for more information.
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
# Security Policy
|
||||
|
||||
If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email to
|
||||
<security@coder.com>.
|
||||
@ -7,15 +7,65 @@
|
||||
"path": "./README.md",
|
||||
"icon_path": "./images/icons/home.svg",
|
||||
"children": [
|
||||
{
|
||||
"title": "Screenshots",
|
||||
"description": "View screenshots of the Coder platform",
|
||||
"path": "./about/screenshots.md"
|
||||
},
|
||||
{
|
||||
"title": "Quickstart",
|
||||
"description": "Learn how to install and run Coder quickly",
|
||||
"path": "./tutorials/quickstart.md"
|
||||
},
|
||||
{
|
||||
"title": "Screenshots",
|
||||
"description": "View screenshots of the Coder platform",
|
||||
"path": "./start/screenshots.md"
|
||||
"title": "Support",
|
||||
"description": "How Coder supports your deployment and you",
|
||||
"path": "./support/index.md",
|
||||
"children": [
|
||||
{
|
||||
"title": "Generate a Support Bundle",
|
||||
"description": "Generate and upload a Support Bundle to Coder Support",
|
||||
"path": "./support/support-bundle.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Contributing",
|
||||
"description": "Learn how to contribute to Coder",
|
||||
"path": "./about/contributing/CONTRIBUTING.md",
|
||||
"icon_path": "./images/icons/contributing.svg",
|
||||
"children": [
|
||||
{
|
||||
"title": "Code of Conduct",
|
||||
"description": "See the code of conduct for contributing to Coder",
|
||||
"path": "./about/contributing/CODE_OF_CONDUCT.md",
|
||||
"icon_path": "./images/icons/circle-dot.svg"
|
||||
},
|
||||
{
|
||||
"title": "Documentation",
|
||||
"description": "Our style guide for use when authoring documentation",
|
||||
"path": "./about/contributing/documentation.md",
|
||||
"icon_path": "./images/icons/document.svg"
|
||||
},
|
||||
{
|
||||
"title": "Backend",
|
||||
"description": "Our guide for backend development",
|
||||
"path": "./about/contributing/backend.md",
|
||||
"icon_path": "./images/icons/gear.svg"
|
||||
},
|
||||
{
|
||||
"title": "Frontend",
|
||||
"description": "Our guide for frontend development",
|
||||
"path": "./about/contributing/frontend.md",
|
||||
"icon_path": "./images/icons/frontend.svg"
|
||||
},
|
||||
{
|
||||
"title": "Security",
|
||||
"description": "Security vulnerability disclosure policy",
|
||||
"path": "./about/contributing/SECURITY.md",
|
||||
"icon_path": "./images/icons/lock.svg"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
@ -810,44 +860,6 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Contributing",
|
||||
"description": "Learn how to contribute to Coder",
|
||||
"path": "./CONTRIBUTING.md",
|
||||
"icon_path": "./images/icons/contributing.svg",
|
||||
"children": [
|
||||
{
|
||||
"title": "Code of Conduct",
|
||||
"description": "See the code of conduct for contributing to Coder",
|
||||
"path": "./contributing/CODE_OF_CONDUCT.md",
|
||||
"icon_path": "./images/icons/circle-dot.svg"
|
||||
},
|
||||
{
|
||||
"title": "Documentation",
|
||||
"description": "Our style guide for use when authoring documentation",
|
||||
"path": "./contributing/documentation.md",
|
||||
"icon_path": "./images/icons/document.svg"
|
||||
},
|
||||
{
|
||||
"title": "Backend",
|
||||
"description": "Our guide for backend development",
|
||||
"path": "./contributing/backend.md",
|
||||
"icon_path": "./images/icons/gear.svg"
|
||||
},
|
||||
{
|
||||
"title": "Frontend",
|
||||
"description": "Our guide for frontend development",
|
||||
"path": "./contributing/frontend.md",
|
||||
"icon_path": "./images/icons/frontend.svg"
|
||||
},
|
||||
{
|
||||
"title": "Security",
|
||||
"description": "Our guide for security",
|
||||
"path": "./contributing/SECURITY.md",
|
||||
"icon_path": "./images/icons/lock.svg"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Tutorials",
|
||||
"description": "Coder knowledgebase for administrating your deployment",
|
||||
@ -874,11 +886,6 @@
|
||||
"description": "Learn about image management with Coder",
|
||||
"path": "./admin/templates/managing-templates/image-management.md"
|
||||
},
|
||||
{
|
||||
"title": "Generate a Support Bundle",
|
||||
"description": "Generate and upload a Support Bundle to Coder Support",
|
||||
"path": "./tutorials/support-bundle.md"
|
||||
},
|
||||
{
|
||||
"title": "Configuring Okta",
|
||||
"description": "Custom claims/scopes with Okta for group/role sync",
|
||||
|
||||
5
docs/support/index.md
Normal file
5
docs/support/index.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Support
|
||||
|
||||
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).
|
||||
|
||||
<children></children>
|
||||
@ -140,7 +140,7 @@ Supported IDEs:
|
||||
Our [Module Registry](https://registry.coder.com/modules) also hosts a variety
|
||||
of tools for extending the capability of your workspace. If you have a request
|
||||
for a new IDE or tool, please file an issue in our
|
||||
[Modules repo](https://github.com/coder/modules/issues).
|
||||
[Modules repo](https://github.com/coder/registry/issues).
|
||||
|
||||
## Ports and Port forwarding
|
||||
|
||||
|
||||
Reference in New Issue
Block a user