Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Gitpod documentation #225

Merged
merged 3 commits into from Apr 15, 2019
Merged

Added Gitpod documentation #225

merged 3 commits into from Apr 15, 2019

Conversation

@gitolicious
Copy link
Contributor

gitolicious commented Apr 14, 2019

Description:

Added Gitpod documentation

Related issue (if applicable): fixes
n/a

Pull request in esphome with YAML changes (if applicable): esphome/esphome#508

Checklist:

  • Branch: next is for changes and new documentation that will go public with the next ESPHome release. Fixes, changes and adjustments for the current release should be created against current.
Copy link
Member

OttoWinter left a comment

I don't know gitpod, please explain what it is and why it should be included here.

  • I'd prefer this not to be advertised as the easiest way. I've not heard of it being used before so I'm hesitant of marking it as the preferred way until more open source projects use it. Also looks like it costs something after some time using it (a big no).

  • See also lint errors.

@gitolicious

This comment has been minimized.

Copy link
Contributor Author

gitolicious commented Apr 15, 2019

Gitpod is on online IDE specifically designed for GitHub projects. I guess you found the web page and the brief intro at https://www.gitpod.io/blog/gitpod-launch/
100 hours a month for open-source projects is free, which I think would suffice for most projects.

To be honest, for me the documentation how to build all ESPHome parts by myself was a bit confusing. Then I remembered I read about the launch of Gitpod last week and gave it a try. Now it's a single click (or 11 letters in your browser address bar) to have your own ESPHome source code in an IDE and it's directly built within seconds with zero installation required.

The configuration file gitpod.yml takes care of the required steps. That's all it does. Userscan give it a go and launch a Gitpod instance -- or they can do as before and check out the repo locally, install all dependencies, configure everything on their machine. Nothing wrong with that and no harm done for them.

gitolicious added 2 commits Apr 15, 2019
@gitolicious

This comment has been minimized.

Copy link
Contributor Author

gitolicious commented Apr 15, 2019

The remaining lint errors originate from somewhere else:

Empty line after heading is missing. Please insert an empty line. See guides/automations.rst:362

9:26:05 PM: /opt/build/repo/guides/automations.rst:363:undefined label: sensor-lambda_calls (if the link has no caption the label must precede a section header)

I didn't touch that file.

@gitolicious

This comment has been minimized.

Copy link
Contributor Author

gitolicious commented Apr 15, 2019

Lint errors fixed in #228 (using GitPod btw 😜)

@OttoWinter

This comment has been minimized.

Copy link
Member

OttoWinter commented Apr 15, 2019

I do think gitpod sounds really cool too, I'm just hesitant to really recommend it until it has been used for a while (and specifically I have also tried it, which I've not yet 🙂 )

About lint error, ah yes that's my bad. base branch has been updated

@OttoWinter OttoWinter merged commit 7637e2b into esphome:current Apr 15, 2019
0 of 2 checks passed
0 of 2 checks passed
continuous-integration/travis-ci/pr The Travis CI build failed
Details
deploy/netlify Deploy preview failed.
Details
@gitolicious

This comment has been minimized.

Copy link
Contributor Author

gitolicious commented Apr 15, 2019

Understood. The changed text offers it as an alternative without a firm suggestion. Let's see how it's future developments and adoption will go.

@gitolicious gitolicious deleted the gitolicious:patch-1 branch Apr 15, 2019
gitolicious added a commit to gitolicious/esphome-docs that referenced this pull request Apr 15, 2019
* Added Gitpod documentation

* Adapted gitpod description

* Line break
@gitolicious

This comment has been minimized.

Copy link
Contributor Author

gitolicious commented Apr 15, 2019

Now that the documentation includes hints on how to use Gitpod for ESPHome, we should probably also merge the .gitpod.yml files as otherwise the "magic" on starting the pods will not happen.
esphome: esphome/esphome#508
esphome-core: esphome/esphome-core#588
esphome-docs: #226

@OttoWinter

This comment has been minimized.

Copy link
Member

OttoWinter commented Apr 16, 2019

Yeah I know, I just had a massive backlog of issues (and still do). That's why I haven't looked at those yet.

@esphome esphome locked and limited conversation to collaborators Jun 24, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
2 participants
You can’t perform that action at this time.