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

📝(tilt) improve tilt doc #689

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

📝(tilt) improve tilt doc #689

wants to merge 2 commits into from

Conversation

mjeammet
Copy link
Member

@mjeammet mjeammet commented Feb 4, 2025

Purpose

I'm trying to install tilt and doc seems outdated/Mac-only. This is an attempt at making it better, especially for linux users.

Proposal

Description...

  • upgrade tilt doc by remove sops-related topics
  • how to add secrets

@mjeammet mjeammet self-assigned this Feb 4, 2025
upgrade tilt doc by remove sops-related topics +
adding linux instructions
@mjeammet mjeammet force-pushed the mpj/upgrade-tilt-doc branch from b2755f9 to 7c0d6e0 Compare February 4, 2025 17:57
Copy link
Member

@qbey qbey left a comment

Choose a reason for hiding this comment

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

Thanks for the cleanup, I'm not fully convinced we should remove the "command without make" part but if you think it helps go ahead :)


```bash
make install-external-secrets
```

### Deploy the application

```bash
# Pro Connect environment
tilt up -f ./bin/Tiltfile
Copy link
Member

Choose a reason for hiding this comment

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

This is the command I use, why remove it? It's common for Tilt users to use it like this

Copy link
Member Author

@mjeammet mjeammet Feb 5, 2025

Choose a reason for hiding this comment

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

but since you made the make tilt-up command, I thought it would lighten the doc to not put both commands everytime. But I lack experience wiht tilt. If this command is especially familiar with the community, maybe we should keep it and add make tilt-up in parenthesis or something like that.

@@ -10,116 +10,48 @@ It's like having a conversation with your cluster.

This guide assumes you have the following tools installed:

- [brew](https://brew.sh/) if you are on linux
Copy link
Member

Choose a reason for hiding this comment

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

I did not need brew on Linux. Do you mean MacOS?
I was hoping someone on MacOS could write a dedicated part about the setup.

Copy link
Member Author

Choose a reason for hiding this comment

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

Didn't you ? Well, I'm on Ubuntu and I there is at least one of these tools (helmfile, I think) is not Debian-friendly at all. Do you remember how you installed it ? Or are you running it as a container ?

I believe @Morendil is also trying to set this up on Mac. Maybe he can pitch in.

Copy link
Member

Choose a reason for hiding this comment

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

The helmfile I used (in docker) is described in the documentation you propose to remove 😅

Copy link
Member

Choose a reason for hiding this comment

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

IMHO except the sops part this documentation don't need much cleanup.
What can be added:

  • another helmfile setup
  • setup on MacOS

@mjeammet mjeammet changed the title 📝(tilt) upgrade tilt doc 📝(tilt) improve tilt doc Feb 5, 2025
@mjeammet mjeammet marked this pull request as ready for review February 5, 2025 15:46
@mjeammet mjeammet requested review from sdemagny and sylvinus February 6, 2025 13:41
improve tilt doc + remove sops-related topics
@mjeammet mjeammet force-pushed the mpj/upgrade-tilt-doc branch from 3fef243 to a0317f8 Compare February 6, 2025 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants