diff --git a/CLAUDE.md b/CLAUDE.md index 90d91c9966df7..e124df8e2d05e 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -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) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 37dadd19667d4..6482f8c8c99f1 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,2 +1,2 @@ -[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) diff --git a/coderd/database/migrations/migrate_test.go b/coderd/database/migrations/migrate_test.go index 65dc9e6267310..cd843bd97aa7a 100644 --- a/coderd/database/migrations/migrate_test.go +++ b/coderd/database/migrations/migrate_test.go @@ -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") } }) diff --git a/docs/contributing/CODE_OF_CONDUCT.md b/docs/about/contributing/CODE_OF_CONDUCT.md similarity index 100% rename from docs/contributing/CODE_OF_CONDUCT.md rename to docs/about/contributing/CODE_OF_CONDUCT.md diff --git a/docs/CONTRIBUTING.md b/docs/about/contributing/CONTRIBUTING.md similarity index 98% rename from docs/CONTRIBUTING.md rename to docs/about/contributing/CONTRIBUTING.md index 3b0d14cb659f2..8f4eb518bae76 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/about/contributing/CONTRIBUTING.md @@ -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 diff --git a/docs/about/contributing/SECURITY.md b/docs/about/contributing/SECURITY.md new file mode 100644 index 0000000000000..7d0f2673ae142 --- /dev/null +++ b/docs/about/contributing/SECURITY.md @@ -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 +. + +Refer to the [Security policy](https://coder.com/security/policy) for more information. diff --git a/docs/contributing/backend.md b/docs/about/contributing/backend.md similarity index 100% rename from docs/contributing/backend.md rename to docs/about/contributing/backend.md diff --git a/docs/contributing/documentation.md b/docs/about/contributing/documentation.md similarity index 100% rename from docs/contributing/documentation.md rename to docs/about/contributing/documentation.md diff --git a/docs/contributing/frontend.md b/docs/about/contributing/frontend.md similarity index 99% rename from docs/contributing/frontend.md rename to docs/about/contributing/frontend.md index 62e86c9ad4ab9..b121b01a26c59 100644 --- a/docs/contributing/frontend.md +++ b/docs/about/contributing/frontend.md @@ -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 diff --git a/docs/start/screenshots.md b/docs/about/screenshots.md similarity index 100% rename from docs/start/screenshots.md rename to docs/about/screenshots.md diff --git a/docs/start/why-coder.md b/docs/about/why-coder.md similarity index 100% rename from docs/start/why-coder.md rename to docs/about/why-coder.md diff --git a/docs/admin/security/index.md b/docs/admin/security/index.md index 84d89d0c34668..37028093f8c57 100644 --- a/docs/admin/security/index.md +++ b/docs/admin/security/index.md @@ -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. diff --git a/docs/admin/templates/extending-templates/modules.md b/docs/admin/templates/extending-templates/modules.md index 1f454bb26540c..d7ed472831662 100644 --- a/docs/admin/templates/extending-templates/modules.md +++ b/docs/admin/templates/extending-templates/modules.md @@ -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" ``` diff --git a/docs/ai-coder/custom-agents.md b/docs/ai-coder/custom-agents.md index 451c47689b6b0..3badc20cd8066 100644 --- a/docs/ai-coder/custom-agents.md +++ b/docs/ai-coder/custom-agents.md @@ -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. diff --git a/docs/contributing/SECURITY.md b/docs/contributing/SECURITY.md deleted file mode 100644 index 7344f126449fe..0000000000000 --- a/docs/contributing/SECURITY.md +++ /dev/null @@ -1,4 +0,0 @@ -# Security Policy - -If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email to -. diff --git a/docs/manifest.json b/docs/manifest.json index 0133eb31c1c9a..e100a561aa40c 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -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", diff --git a/docs/support/index.md b/docs/support/index.md new file mode 100644 index 0000000000000..28787b364f3e1 --- /dev/null +++ b/docs/support/index.md @@ -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). + + diff --git a/docs/tutorials/support-bundle.md b/docs/support/support-bundle.md similarity index 100% rename from docs/tutorials/support-bundle.md rename to docs/support/support-bundle.md diff --git a/docs/user-guides/workspace-access/index.md b/docs/user-guides/workspace-access/index.md index 76c1c77120487..1bf4d9d8c9927 100644 --- a/docs/user-guides/workspace-access/index.md +++ b/docs/user-guides/workspace-access/index.md @@ -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 pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy