mirror of https://github.com/coder/coder.git
fix: prettier misses docs directory (#5285)
* chore: keep admin/prometheus.md if make target fails * Address PR comments * Formatted * fix: prettier misses docs * make fmt * More md files
This commit is contained in:
Marcin Tojek
GitHub
parent
b46035823e
commit
cec667d309
|
|
@ -1,4 +1,5 @@
|
|||
# Adopters
|
||||
|
||||
[](https://coder.com/chat?utm_source=github.com/coder/coder&utm_medium=github&utm_campaign=adopters.md) [](https://twitter.com/coderhq)
|
||||
|
|
@ -8,5 +9,5 @@ Follow](https://img.shields.io/twitter/follow/coderhq?label=%40coderhq&style=soc
|
|||
> 👋 _If you are considering using Coder in your organization please introduce yourself via https://coder.com/demo_ 🙇🏻♂️
|
||||
|
||||
| Organization | Contact | Description of Use |
|
||||
| --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ------------------------------ | --------------------------------------- | ------------------------------ |
|
||||
| [Coder](https://www.coder.com) | [@coderhq](https://twitter.com/coderhq) | Coder builds coder with Coder. |
|
||||
|
|
|
|||
10
Makefile
10
Makefile
|
|
@ -359,9 +359,9 @@ fmt/prettier:
|
|||
cd site
|
||||
# Avoid writing files in CI to reduce file write activity
|
||||
ifdef CI
|
||||
yarn run format:check
|
||||
yarn run format:check . ../*.md ../docs
|
||||
else
|
||||
yarn run format:write
|
||||
yarn run format:write . ../*.md ../docs
|
||||
endif
|
||||
.PHONY: fmt/prettier
|
||||
|
||||
|
|
@ -452,11 +452,7 @@ site/src/api/typesGenerated.ts: scripts/apitypings/main.go $(shell find codersdk
|
|||
docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
|
||||
go run scripts/metricsdocgen/main.go
|
||||
cd site
|
||||
ifdef CI
|
||||
yarn run format:check
|
||||
else
|
||||
yarn run format:write
|
||||
endif
|
||||
yarn run format:write ../docs/admin/prometheus.md
|
||||
|
||||
update-golden-files: cli/testdata/.gen-golden
|
||||
.PHONY: update-golden-files
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ Software development on your infrastructure. Offload your team's development fro
|
|||
|
||||
> "By leveraging Terraform, Coder lets developers run any IDE on any compute platform including on-prem, AWS, Azure, GCP, DigitalOcean, Kubernetes, Docker, and more, with workspaces running on Linux, Windows, or Mac." - **Kevin Fishner Chief of Staff at [HashiCorp](https://hashicorp.com/)**
|
||||
|
||||
|
||||
<p align="center">
|
||||
<img src="./docs/images/hero-image.png">
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@ direnv: export +AR +AS +CC +CONFIG_SHELL +CXX +HOST_PATH +IN_NIX_SHELL +LD +NIX_
|
|||
```
|
||||
|
||||
Alternatively if you do not want to use nix then you'll need to install the need the following tools by hand:
|
||||
|
||||
- Go 1.18+
|
||||
- on macOS, run `brew install go`
|
||||
- Node 14+
|
||||
|
|
@ -63,7 +64,6 @@ Alternatively if you do not want to use nix then you'll need to install the need
|
|||
- [`pandoc`]()
|
||||
- on macOS, run `brew install pandocomatic`
|
||||
|
||||
|
||||
### Development workflow
|
||||
|
||||
Use the following `make` commands and scripts in development:
|
||||
|
|
@ -143,7 +143,6 @@ $ git ls-files v0.12.2 -- coderd/database/migrations/*.up.sql
|
|||
|
||||
This helps in naming the dump (e.g. `000069` above).
|
||||
|
||||
|
||||
## Styling
|
||||
|
||||
### Documentation
|
||||
|
|
|
|||
|
|
@ -92,6 +92,6 @@ Azure, Google Cloud, Kubernetes, and more.
|
|||
- Coder is not a SaaS/fully-managed offering. You must host
|
||||
Coder on a cloud service (AWS, Azure, GCP) or your private data center.
|
||||
|
||||
|
||||
## Up next
|
||||
|
||||
- Learn about [Templates](./templates.md)
|
||||
|
|
|
|||
|
|
@ -7,4 +7,3 @@ Groups can be used with [template RBAC](./rbac.md) to give groups of users acces
|
|||
## Enabling this feature
|
||||
|
||||
This feature is only available with an enterprise license. [Learn more](../enterprise.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ The environment variable `CODER_PROMETHEUS_ENABLE` will be enabled automatically
|
|||
<!-- Code generated by 'make docs/admin/prometheus.md'. DO NOT EDIT -->
|
||||
|
||||
| Name | Type | Description | Labels |
|
||||
| - | - | - | - |
|
||||
| -------------------------------------------- | --------- | ------------------------------------------------------------------ | ---------------------- |
|
||||
| `coderd_api_active_users_duration_hour` | gauge | The number of users that have been active within the last hour. | |
|
||||
| `coderd_api_concurrent_requests` | gauge | The number of concurrent API requests | |
|
||||
| `coderd_api_concurrent_websockets` | gauge | The total number of concurrent API websockets | |
|
||||
|
|
|
|||
|
|
@ -2,13 +2,12 @@
|
|||
|
||||
This style guide is primarily for use with authoring documentation.
|
||||
|
||||
|
||||
## General guidelines
|
||||
|
||||
- Use sentence case, even in titles (do not punctuate the title, though)
|
||||
- Use the second person
|
||||
- Use the active voice
|
||||
- Use plural nouns and pronouns (*they*, *their*, or *them*), especially when
|
||||
- Use plural nouns and pronouns (_they_, _their_, or _them_), especially when
|
||||
the specific number is uncertain (i.e., "Set up your environments" even though
|
||||
you don't know if the user will have one or many environments)
|
||||
- When writing documentation titles, use the noun form, not the gerund form (e.g., "Environment
|
||||
|
|
@ -17,7 +16,7 @@ This style guide is primarily for use with authoring documentation.
|
|||
example, ["A Job creates one or more
|
||||
Pods..."](https://kubernetes.io/docs/concepts/workloads/controllers/job/) is
|
||||
correct when writing about Kubernetes. However, in other contexts, neither
|
||||
*job* nor *pods* would be capitalized. Please follow the conventions set forth
|
||||
_job_ nor _pods_ would be capitalized. Please follow the conventions set forth
|
||||
by the relevant companies and open source communities.
|
||||
|
||||
## Third-party references
|
||||
|
|
@ -26,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/) |
|
||||
|
|
@ -50,14 +49,14 @@ Use **bold** formatting when referring to UI elements.
|
|||
|
||||
### Italics
|
||||
|
||||
Use *italics* for:
|
||||
Use _italics_ for:
|
||||
|
||||
- Parameter names
|
||||
- Mathematical and version variables
|
||||
|
||||
### Code font
|
||||
|
||||
Use *code font* for:
|
||||
Use _code font_ for:
|
||||
|
||||
- User text input
|
||||
- Command-line utility names
|
||||
|
|
@ -68,7 +67,7 @@ Use *code font* for:
|
|||
- HTTP verbs, status codes, and content-type values
|
||||
- Placeholder variables
|
||||
|
||||
Use *code blocks* for code samples and other blocks of code. Be sure to indicate
|
||||
Use _code blocks_ for code samples and other blocks of code. Be sure to indicate
|
||||
the language your using to apply the proper syntax highlighting.
|
||||
|
||||
```text
|
||||
|
|
@ -80,10 +79,10 @@ For code that you want users to enter via a command-line interface, use
|
|||
|
||||
### Punctuation
|
||||
|
||||
Do not use the ampersand (&) as a shorthand for *and* unless you're referring to a
|
||||
UI element or the name of something that uses *&*.
|
||||
Do not use the ampersand (&) as a shorthand for _and_ unless you're referring to a
|
||||
UI element or the name of something that uses _&_.
|
||||
|
||||
You can use the symbol `~` in place of the word *approximately*.
|
||||
You can use the symbol `~` in place of the word _approximately_.
|
||||
|
||||
### UI elements
|
||||
|
||||
|
|
@ -147,4 +146,3 @@ We also do not capitalize the names of user roles:
|
|||
## Standardized spellings
|
||||
|
||||
- WiFi
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,12 @@
|
|||
# Dotfiles
|
||||
|
||||
<!-- markdown-link-check-disable -->
|
||||
|
||||
Coder offers the `coder dotfiles <repo>` command which simplifies workspace
|
||||
personalization. Our behavior is consistent with Codespaces, so
|
||||
[their documentation](https://docs.github.com/en/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#dotfiles)
|
||||
explains how it loads your repo.
|
||||
|
||||
<!-- markdown-link-check-enable -->
|
||||
|
||||
You can read more on dotfiles best practices [here](https://dotfiles.github.io).
|
||||
|
|
|
|||
|
|
@ -4,15 +4,18 @@ Coder is free to use and includes some features that are only accessible with a
|
|||
Contact sales@coder.com to obtain a license.
|
||||
|
||||
### User Management
|
||||
|
||||
- [Groups](./admin/groups.md)
|
||||
- [Template RBAC](./admin/rbac.md)
|
||||
- [SCIM](./admin/auth.md#scim)
|
||||
|
||||
### Networking & Deployment
|
||||
|
||||
- [High Availability](./admin/high-availability.md)
|
||||
- [Browser Only Connections](./networking.md#browser-only-connections)
|
||||
|
||||
### Other
|
||||
|
||||
- [Audit Logging](./admin/audit-logs.md)
|
||||
- [Quotas](./admin/quotas.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -168,7 +168,6 @@ resource "coder_app" "jupyter" {
|
|||
|
||||
|
||||
|
||||
|
||||
### RStudio
|
||||
|
||||
Configure your agent and `coder_app` like so to use RStudio. Notice the
|
||||
|
|
|
|||
|
|
@ -1,9 +1,5 @@
|
|||
{
|
||||
"versions": [
|
||||
"main",
|
||||
"v0.8.1",
|
||||
"v0.7.12"
|
||||
],
|
||||
"versions": ["main", "v0.8.1", "v0.7.12"],
|
||||
"routes": [
|
||||
{
|
||||
"title": "About",
|
||||
|
|
|
|||
|
|
@ -28,7 +28,6 @@ Coder with Docker has the following advantages:
|
|||
|
||||
> This will use Coder's tunnel and built-in database. See our [Docker documentation](../install/docker.md) for other configuration options such as running on localhost, using docker-compose, and external PostgreSQL.
|
||||
|
||||
|
||||
1. In new terminal, [install Coder](../install/) in order to connect to your deployment through the CLI.
|
||||
|
||||
```shell
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ For this tutorial, we will run Coder as a `systemd` service. You can run Coder i
|
|||
|
||||
First, edit the `coder.env` file to enable `CODER_TUNNEL` by setting the value to true with the following command:
|
||||
|
||||
``` sh
|
||||
```sh
|
||||
sudo vim /etc/coder.d/coder.env
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -49,8 +49,9 @@ username, Terraform would recreate the volume (wiping its data!) the next
|
|||
time the workspace restarts.
|
||||
|
||||
Therefore, persistent resource names must only depend on immutable IDs such as:
|
||||
* `coder_workspace.me.owner_id`
|
||||
* `coder_workspace.me.id`
|
||||
|
||||
- `coder_workspace.me.owner_id`
|
||||
- `coder_workspace.me.id`
|
||||
|
||||
```hcl
|
||||
data "coder_workspace" "me" {
|
||||
|
|
@ -64,6 +65,7 @@ resource "docker_volume" "home_volume" {
|
|||
```
|
||||
|
||||
## 🛡 Bulletproofing
|
||||
|
||||
Even if our persistent resource depends exclusively on static IDs, a change to
|
||||
the `name` format or other attributes would cause Terraform to rebuild the resource.
|
||||
|
||||
|
|
|
|||
|
|
@ -92,5 +92,6 @@ Coder stores macOS and Linux logs at the following locations:
|
|||
---
|
||||
|
||||
## Up next
|
||||
|
||||
- Learn about how to personalize your workspace with [Dotfiles](./dotfiles.md)
|
||||
- Learn about using [IDEs](./ides.md)
|
||||
|
|
|
|||
Loading…
Reference in New Issue