Commit Graph

63 Commits

Author SHA1 Message Date
Kyle Carberry 7880b941b8
docs: remove quote from README 2023-01-27 21:24:54 -06:00
Kyle Carberry 8830ddfd56
docs: update the readme to reduce unnecessary text (#5837)
The README was starting to get quite large, and I felt it was a bit bloaty.

- Removes Twitter badge (the API was removed, so it wasn't working anyways)
- Adds tagline to the title (an experiment, but worth a shot)
- Reduces highlights
- Removes recommended reading (people want to get started asap on a repo)
- Updates doc links `/docs/coder-oss` -> `/docs/v2`
- Moves comparison to the bottom
- Removes adopters.md (we never promoted this, so it hasn't been used)
2023-01-25 14:49:15 -06:00
Kyle Carberry e558a252e7
chore: remove dead docs links from README.md (#5731) 2023-01-16 12:27:39 -06:00
Joe Previte 2296432e8b
docs: update space on prem link (#5628) 2023-01-10 19:37:35 -06:00
Geoffrey Huntley 90b0adabc1
docs(readme): uppercase H in Self-Hosted (#5412) 2022-12-14 13:01:51 +00:00
Geoffrey Huntley ec2293a4e4
docs(readme): update comparison table (#5405) 2022-12-14 10:35:20 +01:00
sharkymark 8df02f42c0
docs: make it clear the CLI must be downloaded to use templates (#5373) 2022-12-13 19:31:09 +00:00
Geoffrey Huntley d72d312e1f
docs(readme): update comparison table (#5394) 2022-12-13 00:55:23 +00:00
Geoffrey Huntley 08a6a18226
docs(comparisons): update comparison table (#5371) 2022-12-12 19:14:15 +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
Muhammad Atif Ali b46035823e
docs: add templates link to README.md (#5201) 2022-12-05 16:20:01 +10:00
Geoffrey Huntley 1f4f0cee2a
chore(branding): update branding (#5028) 2022-11-16 07:15:33 -03:00
Dean Sheather 067362cf31
feat: add windows amd64 installer (#4719) 2022-10-26 00:19:54 +10:00
Eric Paulsen 614e40c0f5
add: postgres version requirement (#4611) 2022-10-18 00:24:49 +00:00
Kyle Carberry 3cc77d96eb
feat: Add tunnel by default (#4399)
* feat: Add tunnel by default

If an access URL is not specified, we will always tunnel.

This is from community-member feedback who exclaimed that
it's confusing having the default for `coder server` display
a warning message, and I agree.

There is very little (maybe none) in running `coder server`
without tunnel and without an access URL, so this seems like
overall a much better UX.

* Update install.sh

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

* Update docs/install/packages.md

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

* Fix reset pass test

* Fix e2e test

Co-authored-by: Ben Potter <ben@coder.com>
2022-10-07 08:05:56 -05:00
Ben Potter 3610f09c77
chore: separate install docs (#3859) 2022-09-08 14:41:00 -05:00
Geoffrey Huntley 1b56a8cccb
docs(readme): use /chat link in the README.md (#3868) 2022-09-06 08:58:27 +00:00
Geoffrey Huntley aae57476f1
docs(adopters): add ADOPTERS.md (#3825) 2022-09-03 06:18:04 +00:00
Geoffrey Huntley 0372586382
housekeeping(discord): use /chat instead of the discord.gg link (#3826) 2022-09-03 06:16:57 +00:00
Mathias Fredriksson e749070193
chore: Update readme with note about embedded database (#3488) 2022-08-15 12:32:22 +03:00
Sagar Vora 604f211674
fix: replace broken link with Github contributors graph (#3472) 2022-08-11 14:35:51 +00:00
Kyle Carberry a848e71f58
fix: Make the twitter handle lowercase in README (#3413)
The uppercase was bothering...
2022-08-08 13:17:38 -05:00
Kyle Carberry d275e52a41
fix: Add godoc badge to README (#3412)
This helps allude to the idea that Coder provides an API as
seen in #3411.

This also fixes the codecov badge from always being red ;p
2022-08-08 12:16:40 -05:00
Kyle Carberry 183b2e80b9
fix: Increase zoom of hero for README (#3300)
This was pretty small before which made it difficult to see
what was going on.
2022-07-29 13:39:30 -05:00
Katie Horne 6d0579d6b6
chore: sync readme and install (#2442) 2022-06-19 15:49:42 -05:00
Katie Horne a95d9b17f6
chore: remove index.md (#2403)
* chore: fix broken link

* chore: remove index.md
2022-06-16 14:46:01 +00:00
Kyle Carberry ccd061652b
feat: Add built-in PostgreSQL for simple production setup (#2345)
* feat: Add built-in PostgreSQL for simple production setup

Fixes #2321.

* Use fork of embedded-postgres for cache path
2022-06-15 16:02:18 -05:00
Katie Horne d0794910d9
chore: update link to go to Coder docs instead of GitHub (#2330) 2022-06-15 09:16:43 -05:00
Joe Previte b6899e2c18
docs: slim down readme (#2140)
* docs: move docs table of contents to docs/index.md

* docs: move how it works and IDE support to about.md

* docs: move readme steps to walkthrough

* docs: slim down readme

* refactor: walkthrough -> quickstart

* docs: minor edits
2022-06-08 08:37:03 -07:00
Ketan Gangatirkar 0e1f868f5f
tweak README.md headings around one liner 2022-06-02 14:48:22 -05:00
Ketan Gangatirkar 597994548d
added one liner to run Coder at very top of README.md 2022-06-02 14:47:34 -05:00
Ben Potter 46ffb67d60
feat: one-line install script (#1924)
* feat: one-line install script

* remove homebrew support

* remove arch linux

* use proper filename for packages

* fix variable format

* fix systemd instructions

* fixes to standalone script

* fix missing var bugs

* fix standalone install

* fix for MacOS

* format

* fix armv7 assets and zips

* remove windows

* update install docs

* support external sources with shellcheck

* shfmt

* add external sources to GitHub action & unfold

* change wording

* first template docs

* default to /usr/local instead

* add option for binary name
2022-06-01 14:15:09 -05:00
Ketan Gangatirkar ae4b2d88cd
added links to our issues to reduce necessary thinking to report issues 2022-05-30 14:19:48 -05:00
Ketan Gangatirkar 17a57a44eb
added community links 2022-05-30 14:16:02 -05:00
Ketan Gangatirkar 02692402d8
added #coder in the most prominent least awkward place 2022-05-30 14:12:33 -05:00
Ben Potter bde3779fec
chore: clarify install options in README (#1844)
* chore: clarify install options in README

* clarify the path is an example, not a requirement

* Update README.md

Co-authored-by: Katie Horne <katie@coder.com>

* Update README.md

Co-authored-by: Katie Horne <katie@coder.com>

* Update README.md

Co-authored-by: Katie Horne <katie@coder.com>

* Update README.md

Co-authored-by: Katie Horne <katie@coder.com>

* Update README.md

Co-authored-by: Katie Horne <katie@coder.com>

Co-authored-by: Katie Horne <katie@coder.com>
2022-05-27 18:10:54 +00:00
Ammar Bandukwala e2030bba38
Move competitive comparison to README
And rewrite a bit.

Resolves #1365.
2022-05-27 11:38:25 -05:00
ketang d73a0f4f23
fixed grammar 2022-05-27 11:09:53 -05:00
Ben Potter 655f348812
chore: change README to fancy alpha note 2022-05-27 10:56:35 -05:00
Ammar Bandukwala c5f06acb01
Add alpha disclaimer to README 2022-05-27 09:08:35 -05:00
ketang 951dc2d8b0
update tagline 2022-05-26 17:00:09 -05:00
Joe Previte 4d79b806c0
docs: clarify installing Coder instructions (#1809) 2022-05-26 14:11:58 -07:00
Ammar Bandukwala c5f4d80eda
Shorten README before Install docs 2022-05-24 20:20:08 -05:00
Ammar Bandukwala 95d7e39c80
Rewrite README for launch (#1731) 2022-05-25 00:40:57 +00:00
Oxylibrium 99c79c79db
docs(README): fix links to subpages (#1724) 2022-05-24 19:26:25 +00:00
Joe Previte 0ade49b758
docs: rephrase value statement in README (#1711) 2022-05-24 10:59:20 -07:00
Katie Horne 98c89f80b0
chore: add instructions for installation w/ Docker Compose (#1599)
Co-authored-by: Ben Potter <ben@coder.com>
2022-05-23 19:42:45 +00:00
Abhineet Jain fc46818e31
chore: move contributor list to contributors.md (#1496) 2022-05-23 19:09:45 +00:00
Joe Previte 0622603220
docs: move README to root (#1630)
We noticed that when you download the repo as a ZIP from GitHub, it
places the `README.md` in the root, which causes the relative links to
break.

By moving it to the root, this will fix that issue.
2022-05-20 09:56:50 -07:00
Joe Previte f02b8fda9e
docs(README): move to /docs folder (#871) 2022-04-04 15:48:22 -07:00