Commit Graph

49 Commits

Author SHA1 Message Date
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
Ben Potter efec029675
chore(com): add docs for "coder projects update" (#732) 2022-04-01 13:48:45 -05:00
Kyle Carberry e0172dd4d5
feat: Update README with highlights and getting started guide (#627) 2022-03-28 15:21:00 -05:00
Presley Pizzo 22f820c69b
refactor(site): replace UserContext with userXService (#465)
* Install and configure XState

* userXService - typegen not working yet

* Lint, fix error transitions

* Lint

* Change initial state to handle loss of state

* Fix gitignore

* Fix types by hook or by crook

* Use xservice in all pages

* Glue/visual component separation

* Fix dependency merge

* Lint

* Remove UserContext

* Remove inspector

* Add typegen command to site/out

* Fix index page redirects

* DRY up nav and redirects

* Moves based on merge

* Moving Page helpers into Page dir

* Move xservice into src, update script

* Move and storybook navbarview

* Update docs

* Install MSW

* Reorganization, with apologies

* Missed spots

* Add mock handlers

* Configure jest for msw

* Fix typos

* Shift unit test to NavbarView

* Fix test types

* Rename NavbarView test

* Attempt at test, wip

* Fix config

* Be logged out, only warn

* Conditionally show text to help test

* Use a Context for MSW's sake

* mocks -> test_helpers

* Enable dev tools

* Format

* Fix import

* Fixes

* Lint

* run typegen postinstall

Co-authored-by: Bryan Phelps <bryan@coder.com>
2022-03-18 14:07:08 -04:00
Bryan 15beb98016
docs: Add additional commands (#455)
This adds a couple of missing pieces to the docs:
- More info about `./develop.sh`
- Steps to run the built coder binary manually
  - Starting the server
  - Logging in
  - Creating a project

I attempted to keep them relatively agnostic so they wouldn't be out of date immediately when https://github.com/coder/coder/pull/422 is merged
2022-03-16 03:55:21 +00:00
Bryan 97399f888d
docs: Fix typo in README.md (#440) 2022-03-15 15:55:02 +00:00
Bryan 4c71ff93eb
refactor: Add minimal terraform project (#308)
I was thinking it might be nice to have some example projects (especially as we on-board new developers) to make it easy to create new projects.

This adds the most basic possible terraform module... just an output block. However, it's enough to run `coder projects create` and go through the whole lifecycle of creating a project and workspace (although, it's really boring since there are no parameters).
2022-02-17 21:11:48 -08:00
Bryan c0d547b6a2
refactor: Add install script for coder CLI (#243)
This adds a `make install` target that copies the CLI and other coder binaries to `$GOPATH/bin` Intended to be helpful for developers who aren't familiar with `go` or the directory structure, in running `coder` CLI locally.
2022-02-10 20:32:00 -08:00
Bryan b6fcd8100d
chore: Run 'yarn install' when building (#215)
I noticed when showing the development flow to a few engineers, there was one awkward step - you have to `cd site` and run `yarn install`, and then come back to root to `make build` or `./develop.sh`

This just adds `yarn install` as part of `make build` and `./develop.sh` - so whichever one is run first will start work.
2022-02-09 13:46:46 -08:00
Bryan ace89161fb
feat(cdr): Initial UI scaffolding
This is testing out [Approach 3](https://www.notion.so/coderhq/Workspaces-v2-Initial-UI-Scaffolding-3b07d2847eed48839a7e6f0f2bb9bf56#56256f25d2954897a8ee315f0820cedd) in the UI scaffolding RFC.

Fixes https://github.com/coder/coder/issues/11

The folder structure looks like:
- `site`
    - `components` (buttons, empty state, etc)
    - `pages` (large sections of UI -> composition of components)
    - `theme` (files defining our palette)

Several components were able to be brought in essentially unmodified:
- `SplitButton`
- `EmptyState`
- `Footer`
-  All the icons / logos
- Theming (removed several items that aren't necessary, yet, though)

Other components had more coupling, and need more refactoring:
- `NavBar`
- `Confetti`

Current State:

![2022-01-06 17 16 31](https://user-images.githubusercontent.com/88213859/148475521-96e080cc-1d33-4b8e-a434-29e388936e3f.gif)

For a full working app, there's potentially a lot more to bring in:
- User / Account Settings Stuff
- Users Page
- Organizations Page
(and all the supporting dependencies)
2022-01-12 14:25:12 -08:00
Bryan ec3685bc14
chore: Add documentation of our phased approach to the UX (#15) 2022-01-11 13:05:49 -08:00
Bryan 3a3161aa63
chore: Add semantic pull requests (#5)
Add a semantic-pull-requests configuration (like we have for `coder/m`), to validate commit messages.
2022-01-06 12:49:40 -08:00
Bryan 78973eaf3f
chore: Initial GHA workflow (#1)
This implements an initial GitHub Actions workflow for us - to be run on PRs and on `main` commits.

This just implements a really simple `style/fmt` check - running `prettier` on the `README.md`.

I assumed we'll stick with using a top-level `Makefile` for commands like in `m` and `link` - but open to alternatives, too!

Since I was adding a `package.json` and `node_modules` for this, I realized we were missing `.gitignore`s, so I added some a subset of the ignore files from `coder/m`
2022-01-03 18:54:27 -08:00
Bryan Phelps 8203bf0d2d
chore: Initial README 2022-01-03 18:52:07 +00:00