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

Update new contributor experience #417

Closed
jacobweinstock opened this issue Jan 20, 2021 · 3 comments · Fixed by #545
Closed

Update new contributor experience #417

jacobweinstock opened this issue Jan 20, 2021 · 3 comments · Fixed by #545
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence.
Milestone

Comments

@jacobweinstock
Copy link
Member

jacobweinstock commented Jan 20, 2021

Getting started with the Tinkerbell stack and through this Tink repo the local development path, for me, had a few hurdles.

  • I found it difficult to understand and spin up Tink without diving deep into the code.
  • I haven't been able to generate TLS certificates locally using the scripts found in this repo. They were all very coupled to vagrant with virtualbox.
  • There were a lot of environment variables that were difficult to understand what to set them to without, again, diving deep into the code.
  • make run did not work for me.
ERROR: 
        Can't find a suitable configuration file in this directory or any
        parent. Are you in the right directory?

        Supported filenames: docker-compose.yml, docker-compose.yaml
  • Documentation was difficult to find

Expected Behaviour

lower barrier to use, contribute and understand.

Current Behaviour

see above

Possible Solution

I have a PR here: #418 with proposed changes to add an environment variable to disable TLS in the server and cli. Documentation for all environment variables. New top-level docker compose file. And updated make run target. See PR

Your Environment

  • Operating System and version:
    MacOS Catalina

  • How are you running Tinkerbell? Using Vagrant & VirtualBox, Vagrant & Libvirt, on Packet using Terraform, or give details:
    Running Tink locally with docker-compose.

  • Link to your project or a code example to reproduce issue:

@tstromberg tstromberg added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 27, 2021
@tstromberg
Copy link
Contributor

@jacobweinstock - IMHO, this issue would be a lot more actionable if split into multiple issues. Would you mind doing so, so that they can be attacked one at a time?

@tstromberg tstromberg added the priority/backlog Higher priority than priority/awaiting-more-evidence. label Aug 27, 2021
@jacobweinstock
Copy link
Member Author

I feel that all of these except one have actually been resolved.

I found it difficult to understand and spin up Tink without diving deep into the code.

  • make run now easily stands up the Tink stack.

I haven't been able to generate TLS certificates locally using the scripts found in this repo. They were all very coupled to vagrant with virtualbox.

  • make run and the docker-compose.yaml now handle TLS certs more clearly.

There were a lot of environment variables that were difficult to understand what to set them to without, again, diving deep into the code.

make run did not work for me.

  • This is working well for me now.

@nshalman nshalman added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Oct 19, 2021
@nshalman
Copy link
Member

#545 is a very good start. If anyone wants to pick up from there and complete the work it would be much appreciated.

@displague displague added this to the 0.7.0 milestone Aug 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
4 participants