Commit Graph

43 Commits

Author SHA1 Message Date
Stephen Kirby 341114a020
chore(docs): remove max_ttl docs (#13077)
* removed MAX_TTL docs, updated template-level scheduling controls

* fmt
2024-04-25 16:13:42 -05:00
Stephen Kirby 5a53afda46
minor change to quiet hours docs (#12338) 2024-02-29 14:50:00 -06:00
Muhammad Atif Ali 417270a6d7
chore(docs): remove the `template_update_policies` experiment from docs (#11615) 2024-01-17 00:18:57 +03:00
Ben Potter ee2daedae0
chore: template update policies are GA (#11397) 2024-01-03 15:49:29 -06:00
Dean Sheather 06f519d7f1
docs: add template autostop requirement docs (#11235)
* chore: template autostop requirement docs

* fixup! chore: template autostop requirement docs

* fixes from feedback.

* fmt

---------

Co-authored-by: Ben <me@bpmct.net>
2024-01-03 14:25:25 -06:00
Jon Ayers 45c07317c0
docs: add documentation for template update policies (#11145) 2023-12-11 19:05:25 -06:00
Jon Ayers ad3eb4bb75
Revert "docs: add documentation for template update policies (#10804)" (#10822)
This reverts commit e6dc9eeffc.
2023-11-21 17:10:08 +00:00
Jon Ayers e6dc9eeffc
docs: add documentation for template update policies (#10804)
Co-authored-by: Ben Potter <ben@coder.com>
2023-11-20 16:30:24 -06:00
Ben Potter 3091f8f70c
chore: fix docs for max lifetime (#10706) 2023-11-14 21:08:06 +00:00
Kira Pilot ef70165a8a
feat: add `orphan` option to workspace delete in UI (#10654)
* added workspace delete dialog

* added stories and tests

* PR review

* fix flake

* fixed stories
2023-11-14 11:32:05 -05:00
Muhammad Atif Ali a49e6b88f9
docs: reorganize template docs (#10297)
* docs: rework our "templates" section

* wikistuff

* fix formatting

* add diagram

* reorganize some things

* docs: improve workspaces and templates doc (#9139)

* Reorg, updated/new screenshots, consistent terminology

* First pass

* Another pass

* Added integration section

* New outline for template pages, small updates

* Revised outline for templates, added tutorial

* First pass at tutorial

* Some feedback from Ben.

* Update docs/workspaces.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/workspaces.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/workspaces.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Fixed typos

* Expanded tutorial

I have read the CLA Document and I hereby sign the CLA

* New screenshots, improved tutorial, revised anatomy

* Improved tutorial. Anatomy is now a guided tour.

* First pass at guided tour

* Updated authentication info

* Reorganized the guided tour

* Edited more template pages

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tutorial.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Revised devcontainers and docker-in-workspaces

* Edited and added screenshots

* Prepared first draft, except docs/templates/open-in-coder.md

* Fix typo

* remove legacy parameters and migration guide

* Use coder templates create

* Added screenshot for workspace template variables

* Made it prettier

* Fixed minor typos and markdown problems

* edits to repairing workspaces

* fix broken links in product

* Added troubleshooting, minor corrections.

* fix terminal links

* fmt

---------

Co-authored-by: Muhammad Atif Ali <matifali@live.com>
Co-authored-by: Ben Potter <me@bpmct.net>
Co-authored-by: Atif Ali <atif@coder.com>

* make fmt

* fix merge conflict

* make fmt

* make gen

* update

* lint

* Discard changes to coderd/database/queries.sql.go

* Discard changes to cli/templates.go

* Discard changes to cli/templateversionarchive.go

* Discard changes to cli/templateversions.go

* Update docker-in-workspaces.md

* replace ```sh with ```shell

* open-in-coder

* fmt

* mention coder_metadata in icons.md

* resource_metadata

* use shell

* modules.md

* mention coder registry module

* workspace.md

* resource_metadata

* remove duplication

* address comments

* cleanup

* fmt

* fix broken links

* fix numbering

* mention module registry

* add example

* demote heading

* remove top level entry from manifest

* fmt

---------

Co-authored-by: Ben <me@bpmct.net>
Co-authored-by: Marc Paquette <22124737+marcpaq@users.noreply.github.com>
2023-10-17 14:47:12 +00:00
Muhammad Atif Ali d37f6d80f7
chore(docs): update docs for correct use of shell and console and enforce linewidth (#9245) 2023-08-23 12:27:57 +03:00
Kyle Carberry 22e781eced
chore: add /v2 to import module path (#9072)
* chore: add /v2 to import module path

go mod requires semantic versioning with versions greater than 1.x

This was a mechanical update by running:
```
go install github.com/marwan-at-work/mod/cmd/mod@latest
mod upgrade
```

Migrate generated files to import /v2

* Fix gen
2023-08-18 18:55:43 +00:00
Eric Paulsen 46df6c58bc
docs: add max lifetime docs and refactor UI helper text (#8185) 2023-06-23 17:51:42 -05:00
Bruno Quaresma 944c42dcb6
docs: add docs for the available query filter for workspaces and users (#7875)
* Add docs for user filtering

* Add filter for workspace

* Apply suggestions from code review

Co-authored-by: Muhammad Atif Ali <atif@coder.com>

---------

Co-authored-by: Muhammad Atif Ali <atif@coder.com>
2023-06-06 15:12:10 +00:00
Eric Paulsen 6715cb6a95
docs: resolve README 404s (#7822) 2023-06-02 20:56:06 +00:00
Eric Paulsen d082ab59b4
docs: add note on log truncation (#7821) 2023-06-02 19:36:43 +00:00
Muhammad Atif Ali 0e50afe4cf
fix(docs): fix broken docs (#7138)
* fixing a lot of broken links

* more fixes

* add 0 as valid status codes

https://tools.ietf.org/html/rfc7231#section-6.3.1 --> 0 as status code
2023-04-14 11:11:51 -05:00
Dean Sheather e33941b7c2
feat: allow disabling autostart and custom autostop for template (#6933)
API only, frontend in upcoming PR.
2023-04-04 12:48:35 +00:00
Mathias Fredriksson 22e3ff96be
feat(agent): Add shutdown lifecycle states and shutdown_script support (#6139)
* feat(api): Add agent shutdown lifecycle states

* feat(agent): Add shutdown_script support

* feat(agent): Add shutdown_script timeout

* feat(site): Support new agent lifecycle states

---

Co-authored-by: Marcin Tojek <marcin@coder.com>
2023-03-06 21:34:00 +02:00
Bruno Quaresma 8ef0306c08
Revert "docs: Change console to shell and remove unused elements (#5960)" (#5964)
This reverts commit 61dcf643e8.
2023-02-01 17:05:45 -03:00
Bruno Quaresma 61dcf643e8
docs: Change console to shell and remove unused elements (#5960) 2023-02-01 18:27:11 +00:00
sharkymark 8df02f42c0
docs: make it clear the CLI must be downloaded to use templates (#5373) 2022-12-13 19:31:09 +00:00
Marcin Tojek cec667d309
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
2022-12-05 12:21:09 +01:00
sharkymark 1882edaa9a
docs: change format from console to sh for psql URL and coder update repair sections (#4878) 2022-11-03 10:56:20 -05:00
sharkymark 3fc3b9f89f
docs: add psql URL for built-in db and repair workspace CLI (#4864) 2022-11-02 23:56:24 +00:00
Ammar Bandukwala a0249bea61
docs: better explain persistent resources (#4703) 2022-10-24 19:59:27 +00:00
Eric Paulsen 54261b6e8b
docs: add auto-start/stop (#4728)
* docs: add auto-start/stop

* feedback

Co-authored-by: Ben Potter <ben@coder.com>

Co-authored-by: Ben Potter <ben@coder.com>
2022-10-24 15:32:05 -04:00
Denbeigh Stevens 36a599ea9a
docs: fix ephemeral resources link (#4101)
[This link](https://coder.com/docs/coder-oss/latest/templates#persistent-and-ephemeral-resources)
directs to the top of the Templates page, we should use
[this link](https://coder.com/docs/coder-oss/latest/templates#persistent-vs-ephemeral-resources) instead.
2022-09-19 02:23:17 +00:00
Roman Zubov a21a6d2f4a
docs: replaced manual up next blocks with doc tag in workspaces.md (#3023)
* docs: replaced manual up next blocks with doc tag in workspaces.md

* replaced up next blocks with <doc page=""> tags

* revert back to markdown

now that we updated how these links work, we can have them as markdown on github and as cards on the docs website.

Co-authored-by: Anton Korzhuk <antonkorzhuk@gmail.com>
2022-08-25 08:26:04 -07:00
Ammar Bandukwala d7b96f7d58
Correct spelling of macOS (#3478)
* Correct spelling of macOS

* fixup! Correct spelling of macOS

* fixup! Correct spelling of macOS
2022-08-11 21:22:06 -04:00
Ammar Bandukwala f82df1bd78
docs: clean up English (#3324)
Fix issues from #3319 and #3320
2022-07-31 20:06:05 +00:00
Ali Diamond 6ef8a625d5
Update workspaces.md (#2993)
adding missing command word
2022-07-14 18:31:01 +00:00
Katie Horne 4eda7034ee
chore: fix broken links to use full path (#2606) 2022-06-23 09:04:31 -05:00
Katie Horne f476a4ad37
chore: fix broken links and formatting issues (#2547) 2022-06-21 13:13:38 +00:00
Ammar Bandukwala de213934d1
docs: expand dotfiles section (#2444) 2022-06-16 18:48:18 -05:00
Katie Horne 535481139a
chore: add IDEs page to sidebar (#2443) 2022-06-16 18:09:40 -05:00
Katie Horne 6c1a111fa9
chore: add IDEs page (#2388) 2022-06-16 11:22:14 -05:00
Ben Potter 42c6b0849d
example: add and document dotfiles usage (#2046) 2022-06-08 21:23:54 +00:00
David Wahler f8410dee3a
fix: include subdirectories in example templates (#1715) 2022-05-25 10:34:28 -05:00
Katie Horne 6f969214d3
chore: validate docs (#1485) 2022-05-19 08:01:19 -05:00
Kyle Carberry c2b5009208
fix: Unnest workspaces command to the top-level (#1241)
This changes all "coder workspace *" commands to root.
A few of these were already at the root, like SSH. The
inconsistency made for a confusing experience.
2022-05-02 11:08:52 -05:00
Ben Potter 22668c388c
feat: initial docs pages (#1107)
* docs structure and edits to getting started

* draft for about page

* skeleton for concepts page

* attempt at explaining templates

* left-align tables

* add best practices and variables

* update structrure

* update structure

* templates are shared

* workspaces docs

* remove coming soon

* fix typos

* docs structure and edits to getting started

* draft for about page

* skeleton for concepts page

* attempt at explaining templates

* left-align tables

* add best practices and variables

* update structrure

* update structure

* templates are shared

* workspaces docs

* remove coming soon

* fix typos

* fix typos

* Update docs/about.md

Co-authored-by: Joe Previte <jjprevite@gmail.com>

* remove line breaks between bullets

* rename variables to parameters

* reduce limits

* chore: edit text

* revert some changes, fix footnotes

Co-authored-by: Katie Horne <katie@coder.com>
Co-authored-by: Joe Previte <jjprevite@gmail.com>
2022-04-26 12:10:50 -05:00