Marcin Tojek
cfd02d959c
docs: api root, buildinfo, csp ( #5493 )
...
* docs: Applications
* WIP
* WIP
* WIP
* Fix: consume
* Fix: @Description
* Fix
* docs: apiroot, buildinfo, csp
* Fix: buildinfo
* docs: updatecheck
* docs: apiroot
* Fix: s/none//g
* Fix: godoc nice
* Fix: description
* Fix: It
* Fix: code sample trim empty line
* More fixes
* Fix: br
* Merge
* Fix: no-security on updatecheck
* Fix: code tags
* Fix: enumerated values in code tags
* Rephrased
* Address PR comments
* Fix: URL, id
* Fix: array items
* Fix: any property
* Fix: array item singular
2022-12-22 15:53:14 +01:00
Marcin Tojek
2bbeff53f9
docs: applications and authorization ( #5477 )
...
* docs: Applications
* WIP
* WIP
* WIP
* Fix: consume
* Fix: @Description
* Fix
* Fix: s/none//g
* Fix: godoc nice
* Fix: description
* Fix: It
* Fix: code sample trim empty line
* More fixes
* Fix: br
2022-12-21 15:37:30 +01:00
Marcin Tojek
dc6d271293
feat: Build framework for generating API docs ( #5383 )
...
* WIP
* Gen
* WIP
* chi swagger
* WIP
* WIP
* WIP
* GetWorkspaces
* GetWorkspaces
* Markdown
* Use widdershins
* WIP
* WIP
* WIP
* Markdown template
* Fix: makefile
* fmt
* Fix: comment
* Enable swagger conditionally
* fix: site
* Default false
* Flag tests
* fix
* fix
* template fixes
* Fix
* Fix
* Fix
* WIP
* Formatted
* Cleanup
* Templates
* BEGIN END SECTION
* subshell exit code
* Fix
* Fix merge
* WIP
* Fix
* Fix fmt
* Fix
* Generic api.md page
* Fix merge
* Link pages
* Fix
* Fix
* Fix: links
* Add icon
* Write manifest file
* Fix fmt
* Fix: enterprise
* Fix: Swagger.Enable
* Fix: rename apidocs to apidoc
* Fix: find -not -prune
* Fix: json not available
* Fix: rename Coderd API to Coder API
* Fix: npm exec
* Fix: api dir
* Fix: by ID
* Fix: string uuid
* Fix: include deleted
* Fix: indirect go.mod
* Fix: source lib.sh
* Fix: shellcheck
* Fix: pushd popd
* Fix: fmt
* Fix: improve workspaces
* Fix: swagger-enable
* Fix
* Fix: mention only HTTP 200
* Fix: IDs
* Fix: https
* Fix: icon
* More APis
* Fix: format swagger.json
* Fix: SwaggerEndpoint
* Fix: SCRIPT_DIR
* Fix: PROJECT_ROOT
* Fix: use code tags in schemas.md
* Fix: examples
* Fix: examples
* Fix: improve format
* Fix: date-time,enums
* Fix: include_deleted
* Fix: array of
* Fix: parameter, response
* Fix: string time or null
* Workspaces: more docs
* Workspaces: more docs
* Fix: renderDisplayName
* Fix: ActiveUserCount
* Fix
* Fix: typo
* Templates: docs
* Notice: incomplete
2022-12-19 18:43:46 +01:00
Ammar Bandukwala
1cfe5de1c5
Add Service Banners ( #5272 )
2022-12-06 18:38:38 +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
Marcin Tojek
38bdae7016
docs: Prometheus metrics + generator ( #5179 )
...
* docs: Prometheus metrics
* Fix
* Typo
* Typo
* Typo
* Fix: link
* Update docs/admin/prometheus.md
Co-authored-by: Dean Sheather <dean@deansheather.com>
* Update docs/admin/prometheus.md
Co-authored-by: Dean Sheather <dean@deansheather.com>
* Update docs/admin/prometheus.md
Co-authored-by: Dean Sheather <dean@deansheather.com>
* Update docs/admin/prometheus.md
Co-authored-by: Dean Sheather <dean@deansheather.com>
* Update docs/admin/prometheus.md
Co-authored-by: Dean Sheather <dean@deansheather.com>
* Rephrase
* notice
* use ```shell
* Generator
* gosec
* fix: lint
* PR comments
* not needed anymore
Co-authored-by: Dean Sheather <dean@deansheather.com>
Co-authored-by: Geoffrey Huntley <ghuntley@ghuntley.com>
2022-11-30 17:39:51 +01:00
Ben Potter
bda76368bc
docs: git auth ( #4902 )
2022-11-07 19:04:00 +00:00
Marcin Tojek
dad89453d4
docs: Setup external PostgreSQL server ( #4901 )
...
* docs: Setup external PostgreSQL server
* Update docs/install/database.md
Co-authored-by: Mathias Fredriksson <mafredri@gmail.com>
* Use user:password pattern
* Fix
Co-authored-by: Mathias Fredriksson <mafredri@gmail.com>
2022-11-04 21:15:03 +01:00
Ben Potter
75da08740c
docs: consolidate docker quickstarts ( #4882 )
2022-11-04 04:30:10 +10:00
Ammar Bandukwala
a0249bea61
docs: better explain persistent resources ( #4703 )
2022-10-24 19:59:27 +00:00
Ammar Bandukwala
a82f05a0a0
docs: move enterprise to root ( #4720 )
2022-10-24 18:10:06 +00:00
Ali Diamond
eb04a7e7a5
feat: adding gcp quickstart ( #4348 )
...
* adding gcp tutorial
* refactor(seo): gcp to google cloud platform
* docs(quickstart): add next steps and title
* adding changes and gcp image
* adding ammar changes
Co-authored-by: Ali Diamond <user@ali.dev>
Co-authored-by: Geoffrey Huntley <ghuntley@ghuntley.com>
2022-10-19 13:52:56 -05:00
Ben Potter
0727c98313
docs: offline (air-gapped) installs ( #4644 )
...
* chore: add docs for offline (air-gapped) installs
* mention postgresql
2022-10-19 06:12:43 -05:00
Kyle Carberry
4e44716b0c
docs: add high availability ( #4583 )
...
- Rename `CODER_DERP_SERVER_RELAY_ADDRESS`
Co-authored-by: Ammar Bandukwala <ammar@ammar.io>
2022-10-17 14:27:38 -05:00
Ben Potter
2a1bfb3e44
docs: API tokens & CI automation ( #4510 )
...
* reword: chore: add CI to dogfood template
* use hardcoded URL
* use consistent name for tokens
* chore: add docs for template change management
* add an example
* fix case
2022-10-12 15:43:59 +00:00
Bruno Quaresma
c13e68248b
docs: Add initial docs to groups and rbac ( #4455 )
...
* docs: Add initial docs to groups and rbac
* Update manifest
* Apply suggestions from code review
Co-authored-by: Joe Previte <jjprevite@gmail.com>
* use single user icon
* chore: add labels and standardize enterprise messaging
* clarify template role
* add groups role
* fix typo
* rename access to use
Co-authored-by: Joe Previte <jjprevite@gmail.com>
Co-authored-by: Ben <me@bpmct.net>
2022-10-11 13:34:41 -05:00
Geoffrey Huntley
cf999f3e28
docs(contributing): styleguide for authoring docs ( #4355 )
2022-10-10 23:33:25 +00:00
Ammar Bandukwala
c01910fb75
docs: use enterprise badges ( #4428 )
2022-10-07 23:44:41 -05:00
Ben Potter
ea42212a2a
chore: add icons to quickstarts ( #4379 )
2022-10-06 10:56:46 -04:00
Ammar Bandukwala
a6bb3b29d0
docs: add quotas ( #4366 )
2022-10-04 20:55:43 +00:00
Ammar Bandukwala
db7030716d
docs: add minor quickstart fixups ( #4363 )
...
- And fix Telemetry in manifest.json
2022-10-04 14:57:06 -05:00
Ammar Bandukwala
a1056bfa2a
docs: describe our telemetry ( #2641 )
2022-10-04 04:03:46 +00:00
Ali Diamond
1d88b9c65c
Add AWS and Azure quickstarts ( #4176 )
...
* Creating Azure QS and adding images
* adding AWS images and QS, plus fix on azure
* adding ben changes
* adding ammar changes
* adding ammar and ben edits
* pushing final changes to AWS
* removed troubleshooting
* fixing access word
* ammar pls
Co-authored-by: Ali Diamond <user@ali.dev>
2022-10-03 17:15:52 -04:00
Ammar Bandukwala
518f6960d0
docs: add missing icons to Administration section ( #4233 )
2022-09-28 10:12:31 -05:00
Bruno Quaresma
c37ecdb9ff
feat: Add port forward button ( #4167 )
2022-09-26 14:56:17 +00:00
Ben Potter
9e099b543f
chore: revert open in coder docs for now ( #4154 )
...
* chore: revert open in coder docs for now
* remove in dogfood
2022-09-22 18:02:11 +00:00
Joe Previte
764600003b
feat: add open in coder docs, fix missing templates ( #4124 )
...
* docs: add open in coder
This adds new documentation for the "Open in Coder" button that admins
can use to get their developers up and running faster.
* fix: display error if template not found
Previously, we weren't handling a case where we tried to get a template
that returned a 404 from the backend.
Now we handle that case in our state machine and display the error
message from the API on the frontend.
* feat: support template query param in index
This adds support to navigate directly to a template from the index by
using the `?template=<name>` query param.
* Revert "feat: support template query param in index"
This reverts commit bad7ffb677
.
We decided to use the `/template/path` route instead.
* fixup!: docs: add open in coder
* docs: add open in coder to dogfood readme
* Update docs/admin/open-in-coder.md
Co-authored-by: Ben Potter <ben@coder.com>
* Update docs/admin/open-in-coder.md
Co-authored-by: Ben Potter <ben@coder.com>
* Update docs/admin/open-in-coder.md
Co-authored-by: Ben Potter <ben@coder.com>
2022-09-22 08:48:03 -07:00
Ben Potter
353fb8724a
add docs: "docker in docker" and "systemd in docker" ( #4051 )
2022-09-19 16:33:31 +00:00
Ammar Bandukwala
7e54413d3b
docs: add networking ( #4030 )
2022-09-12 19:07:03 +00:00
Bruno Quaresma
43f368dfc4
docs: Add audit logs docs ( #3975 )
...
* docs: Add audit logs docs
* Apply suggestions from code review
Co-authored-by: Joe Previte <jjprevite@gmail.com>
* Add contact link
Co-authored-by: Joe Previte <jjprevite@gmail.com>
2022-09-12 01:04:56 +00:00
Kyle Carberry
849e389388
Update manifest.json
2022-09-09 15:53:00 -05:00
Spike Curtis
ba6a868a80
Licensed features docs ( #3934 )
...
* Licensed features docs
Signed-off-by: Spike Curtis <spike@coder.com>
* Licensed features -> Enterprise features
Signed-off-by: Spike Curtis <spike@coder.com>
Signed-off-by: Spike Curtis <spike@coder.com>
2022-09-09 20:10:39 +00:00
sharkymark
c026464375
chore: add uninstall steps to remove a Coder OSS deployment from `docs` ( #3742 )
...
Co-authored-by: Ben <ben@coder.com>
2022-09-09 00:31:29 +00:00
Ben Potter
3610f09c77
chore: separate install docs ( #3859 )
2022-09-08 14:41:00 -05:00
Ammar Bandukwala
5e36be8cbb
docs: remove architecture diagram ( #3615 )
...
The diagram was more confusion than helpful.
2022-08-22 10:56:10 -05:00
Ammar Bandukwala
d37fb054c8
docs: outdent remote desktop docs ( #3614 )
...
Resolves #3590
2022-08-21 01:59:40 +00:00
Ammar Bandukwala
8cf82112ad
docs: document additional roles ( #3496 )
...
Co-authored-by: Steven Masley <stevenmasley@coder.com>
2022-08-12 22:42:16 +00:00
Ammar Bandukwala
4e6645af50
docs: outdent generic quickstart ( #3467 )
2022-08-10 21:53:35 -05:00
Eric Paulsen
272962cfae
docs: add upgrade page & update getting started ( #3439 )
2022-08-10 17:56:21 -05:00
Ammar Bandukwala
3ceee76784
docs: explain resource metadata ( #3447 )
2022-08-09 20:21:26 -05:00
Ammar Bandukwala
c73f708678
docs: remove configuring prefix from IDEs ( #3446 )
2022-08-09 20:10:09 -05:00
Ammar Bandukwala
815bf1b668
docs: fix IDE icon ( #3445 )
2022-08-09 20:07:51 -05:00
Ammar Bandukwala
13a2014d7f
docs: fix up port-forwarding ( #3403 )
...
- Improve English
- Make new page live in manifest.json
- Add icon
- Outdent page to root
2022-08-07 22:22:47 +00:00
Noah Huppert
877519232c
Added Emacs Tips Documentation ( #3247 )
2022-08-01 16:47:22 -05:00
Anton Korzhuk
80223a5e41
replace inline svgs with svg icon_path ( #3332 )
2022-08-01 16:57:51 +00:00
Kyle Carberry
3d0febdd90
feat: Add OIDC authentication ( #3314 )
...
* feat: Add OIDC authentication
* Extract username into a separate package and add OIDC tests
* Add test case for invalid tokens
* Add test case for username as email
* Add OIDC to the frontend
* Improve comments from self-review
* Add authentication docs
* Add telemetry
* Update docs/install/auth.md
Co-authored-by: Ammar Bandukwala <ammar@ammar.io>
* Update docs/install/auth.md
Co-authored-by: Ammar Bandukwala <ammar@ammar.io>
* Remove username package
Co-authored-by: Ammar Bandukwala <ammar@ammar.io>
2022-07-31 23:05:35 -05:00
Ammar Bandukwala
f82df1bd78
docs: clean up English ( #3324 )
...
Fix issues from #3319 and #3320
2022-07-31 20:06:05 +00:00
mark-theshark
7367253097
chore: update jetbrains gateway docs with screenshots ( #3320 )
...
* chore: update jetbrains gateway with screenshots
* organize & add to manifest
Co-authored-by: Ben <ben@coder.com>
2022-07-30 17:29:05 -05:00
Ammar Bandukwala
09776f33dd
docs: rm postgres ( #3313 )
...
This is not our job.
2022-07-29 19:55:40 +00:00
Ammar Bandukwala
5802c29c38
docs: add versions ( #3147 )
...
Resolves #3111
2022-07-27 10:52:18 -04:00
Ammar Bandukwala
87b0b4b1ea
docs: add secrets ( #3057 )
2022-07-20 07:31:33 -05:00
Ammar Bandukwala
13d7466ebc
docs: add Docker quickstart ( #2875 )
...
* Fix docker-compose file
* Add docker quickstart
2022-07-11 12:05:05 -05:00
Eric Paulsen
7dc3f5f92b
init: oauth docs ( #2565 )
...
* init: oauth docs
* chore: update directories
* update: feedback
2022-06-22 15:25:06 -05:00
Katie Horne
34222b2260
chore: add doc on roles, user management ( #2548 )
2022-06-22 13:36:48 +00:00
Katie Horne
f476a4ad37
chore: fix broken links and formatting issues ( #2547 )
2022-06-21 13:13:38 +00:00
Ben Potter
a19493bd53
add docs for web IDEs (code-server, JetBrains Projector, VNC) ( #2448 )
...
* add "configuring web IDEs" doc
* no jupyterhub for now
* change location of web IDE page
* add Dockerfile example
* add run instructions
2022-06-19 20:45:14 +00:00
Ammar Bandukwala
40ef1546e1
docs: add architecture page ( #2450 )
2022-06-16 23:46:02 -05: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
a09d2af977
chore: add basic postgres instructions for byo databases ( #2430 )
2022-06-16 17:54:15 -05:00
Ammar Bandukwala
82c4b80c67
Docs touchups ( #2421 )
...
* Make secrets docs louder
* docs: a bunch of small touchups
2022-06-16 17:47:10 +00:00
Ammar Bandukwala
29c9c1d928
docs: small improvements to install ( #2400 )
...
* Simplify install docs
* docs: clarify security policy
2022-06-16 12:30:56 +00:00
Ammar Bandukwala
2e625c1d9b
docs: use about as home page ( #2382 )
...
* docs: use About as home page
* docs: format install.md
2022-06-15 14:03:13 -05:00
Katie Horne
afa5443180
chore: update docs manifest to reflect current Coder version number ( #2342 )
2022-06-15 14:25:12 +00:00
Joe Previte
fcc52846da
fix: update icon ( #2216 )
2022-06-10 11:23:20 -05:00
Bruno Quaresma
d04d527f2c
chore: Update docs manifest home page and icons ( #2133 )
...
* chore: Update docs manifest home page and icons
* RRemove contributors
* Update template icon
* fixup: manifest.json changes
* fix: add missing readme to root
* fix: add readme to /docs with toc
* fix: add quickstart to manifest
Co-authored-by: Joe Previte <jjprevite@gmail.com>
2022-06-09 18:46:16 +00:00
Bruno Quaresma
3a79759405
fix: Docs paths ( #2131 )
2022-06-07 16:29:18 +00:00
Bruno Quaresma
2b0662bf48
fix: Add .md extension to the docs routes ( #2128 )
2022-06-07 15:56:05 +00:00
Katie Horne
3f1e885d21
chore: add manifest.json ( #2100 )
2022-06-07 09:30:34 -05:00