Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Conversation

IAmHughes
Copy link
Contributor

This begins adding the Getting Started doc to the docs repo.

@khorne3 I've not added it to the manifest as I wasn't sure where you wanted it to live. Would love an initial review and we can iterate from here!

@IAmHughes IAmHughes added the docs 📝 Improvements or additions to documentation label Jun 30, 2021
@IAmHughes IAmHughes requested review from khorne3 and bpmct June 30, 2021 21:11
@IAmHughes IAmHughes self-assigned this Jun 30, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Jun 30, 2021

✨ Coder.com for PR #458 deployed! It will be updated on every commit.

@IAmHughes IAmHughes requested a review from ashumz June 30, 2021 21:17
@IAmHughes IAmHughes changed the title Add Getting Started Doc WIP - Add Getting Started Doc Jul 1, 2021
@khorne3
Copy link
Contributor

khorne3 commented Jul 2, 2021

We need an icon, but not too shabby:

Screen Shot 2021-07-02 at 2 55 17 PM

@ericpaulsen
Copy link
Member

where do we source our icons from? i'll keep an eye out any potential candidates.

@IAmHughes
Copy link
Contributor Author

IAmHughes commented Jul 2, 2021

We need an icon, but not too shabby:

I vote for a 🚀 or ☕ or something.

where do we source our icons from?

I don't know specifically where, but these are material design I believe (maybe Flat) and a site like this would have a load of examples, and there are similar sites to download them as well.

@khorne3
Copy link
Contributor

khorne3 commented Jul 6, 2021

I grabbed a coffee cup from Bootstrap icons; there aren't rockets, but they have angled arrows that could work as well.

@IAmHughes IAmHughes requested a review from bpmct July 6, 2021 16:41
@IAmHughes IAmHughes changed the title WIP - Add Getting Started Doc Add Getting Started Doc Jul 6, 2021
@IAmHughes
Copy link
Contributor Author

@bpmct can you re-review. With the changes from @khorne3 I think we're good to merge once approved.

Copy link
Member

@bpmct bpmct left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. created suggestions for the items discussed

Co-authored-by: Ben Potter <me@bpmct.net>
@khorne3
Copy link
Contributor

khorne3 commented Jul 7, 2021

@bpmct Thanks so much. (I'd made the fixes but forgot to push them 🤦‍♀️ )

@IAmHughes
Copy link
Contributor Author

It looks like we're good to merge @khorne3, just wanted to make sure before I hit the button, haha

@khorne3 khorne3 merged commit c84ee2e into main Jul 7, 2021
@khorne3 khorne3 deleted the IAmHughes/add-getting-started branch July 7, 2021 14:54
jawnsy added a commit that referenced this pull request Jul 14, 2021
* hotfix: Templates language [ch14098] (#466)

* hotfix: Templates language [ch14098]

This implements task 2 (documentation) for normalizing the language
around workspace templates.

Details:

* Rename workspaces-as-code directory to workspace-templates
* Replace WAC and Workspaces as code with workspace templates

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

* chore: add status information to workspaces (#443)

* [ImgBot] Optimize images (#469)

*Total -- 195.86kb -> 172.63kb (11.86%)

/assets/workspaces/workspace-overview.png -- 134.26kb -> 116.30kb (13.37%)
/assets/workspaces/status-chip.png -- 61.60kb -> 56.33kb (8.56%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>

Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>

* Add Getting Started Doc (#458)

* fix formatting issues in k3s docs (#477)

* Expand instructions on creating a configure file (#476)

* chore: bump husky from 7.0.0 to 7.0.1 (#464)

Bumps [husky](https://github.com/typicode/husky) from 7.0.0 to 7.0.1.
- [Release notes](https://github.com/typicode/husky/releases)
- [Commits](typicode/husky@v7.0.0...v7.0.1)

---
updated-dependencies:
- dependency-name: husky
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore: bump @types/minimist from 1.2.1 to 1.2.2 (#468)

Bumps [@types/minimist](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/minimist) from 1.2.1 to 1.2.2.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/minimist)

---
updated-dependencies:
- dependency-name: "@types/minimist"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore: document special case re: GitHub and callback/dev URLs (#475)

chore: document special case re: GitHub and callback/dev URLs

Co-authored-by: Ben Potter <me@bpmct.net>

* chore: update dependabot version ignores (#478)

* Open pull requests for major version updates for GitHub Actions
* Ignore version updates for Node.js types

* chore: bump @types/node from 12.20.15 to 12.20.16 (#481)

Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 12.20.15 to 12.20.16.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore: clarify version support policy (#232)

Recommend that users track supported Kubernetes versions, and remove
the reference to version 1.13.

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

* Begin Openshift docs

Document openshift image tweaks required.
Omit docs on how to use openshift registry

* add buildconfig example

* change list style

* add more detaila bout security context settings

* Begin Openshift docs

Document openshift image tweaks required.
Omit docs on how to use openshift registry

* add buildconfig example

* change list style

* add more detaila bout security context settings

* Edit text

Co-authored-by: G r e y <grey@coder.com>
Co-authored-by: Katie Horne <katie@coder.com>
Co-authored-by: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com>
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
Co-authored-by: Thomas Hughes <2894107+IAmHughes@users.noreply.github.com>
Co-authored-by: Ben Potter <me@bpmct.net>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jonathan Yu <jonathan@coder.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs 📝 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants