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 README.md #56

Merged
merged 5 commits into from
Nov 7, 2024
Merged

Update README.md #56

merged 5 commits into from
Nov 7, 2024

Conversation

noahtalerman
Copy link
Member

  • Remove the "why"
    • @noahtalerman: Hypothesis is that users who land here want to get started fast. They already know the why or don't care
  • Remove note about fleetctl gitops. Users don't interact w/ it
  • Simplify headers

@noahtalerman
Copy link
Member Author

Remove the "why"

FYI @rachaelshaw I took this TODO

@noahtalerman
Copy link
Member Author

Hey @getvictor unrelated to this PR, what do we use this Fleet GitOps repo in GitLab for? https://gitlab.com/developers6254743/fleet-gitops

I was recently invited.

@getvictor
Copy link
Member

Hey @getvictor unrelated to this PR, what do we use this Fleet GitOps repo in GitLab for? https://gitlab.com/developers6254743/fleet-gitops

I was recently invited.

We need a GitLab repo to test the GitLab CI (.gitlab-ci.yml). It is a mirror of this repo. But we need the URL to be something like https://gitlab.com/fleetdm/fleet-gitops
I'm waiting for @lukeheath to sort it out.

@noahtalerman
Copy link
Member Author

We need a GitLab repo to test the GitLab CI (.gitlab-ci.yml).

@getvictor ah, ok.

Will our users ever interact w/ it? Or is the best practice to clone the GitHub repo using GitLab?

Wondering b/c, as someone new to GitLab, I'm confused looking at the steps in the README:

Screenshot 2024-10-29 at 4 21 20 PM
Screenshot 2024-10-29 at 4 22 09 PM

How do I clone the repo if I'm using GitLab? Do I create a GitLab repo after I clone the GitHUb repo?

@getvictor
Copy link
Member

getvictor commented Oct 29, 2024

We need a GitLab repo to test the GitLab CI (.gitlab-ci.yml).

@getvictor ah, ok.

Will our users ever interact w/ it? Or is the best practice to clone the GitHub repo using GitLab?

Wondering b/c, as someone new to GitLab, I'm confused looking at the steps in the README:

Screenshot 2024-10-29 at 4 21 20 PM Screenshot 2024-10-29 at 4 22 09 PM

How do I clone the repo if I'm using GitLab? Do I create a GitLab repo after I clone the GitHUb repo?

Both GitHub and GitLab use git. So terms like clone and push are git-specific, and don't refer to any specific git UI. If the repo is mirrored in both GitHub and GitLab, then users can clone from either place.

@lukeheath
Copy link
Member

@noahtalerman @getvictor I created it: https://gitlab.com/fleetdm/fleet-gitops

@getvictor You should have access but let me know if not.

@noahtalerman
Copy link
Member Author

noahtalerman commented Nov 5, 2024

If the repo is mirrored in both GitHub and GitLab, then users can clone from either place.

@getvictor does this mean that any change (commit) in GitHub will be reflected in GitLab and vice versa?

@getvictor, the changes in this PR are my pass at simplifying the setup instructions. What do you think?

For later:

Now that we have a GitHub and GitLab repo, my understanding is that we could simplify the setup steps further by removing these steps:

Screenshot 2024-11-05 at 12 57 07 PM

Screenshot 2024-11-05 at 12 57 52 PM

I think we can come back to this later. My understanding is that this would require making changes to the GitHub and GitLab repos and maintaining these repos separately.

@getvictor
Copy link
Member

@noahtalerman Commit to GitHub will be reflected in GitLab, but not vice versa.

The changes look good.

The deletion step 4 is optional, so we could simply remove it.

Copy link
Member

@getvictor getvictor left a comment

Choose a reason for hiding this comment

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

Looks good. One comment.

README.md Outdated

1. Create your own GitLab repository.
1. Clone the [GitLab repository](https://gitlab.com/fleetdm/fleet-gitops), create your own GitLab repository, and push your clone to your new repo.
Copy link
Member

Choose a reason for hiding this comment

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

At this point, the pipeline/action will run and fail because the secrets are not present. We could call it out.

Copy link
Member Author

Choose a reason for hiding this comment

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

he pipeline/action will run and fail because the secrets are not present.

@getvictor only for GitLab right? I added a note.

Copy link
Member

Choose a reason for hiding this comment

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

For both (although I haven't tried this updated flow with GitLab)

Copy link
Member Author

Choose a reason for hiding this comment

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

For both

Added for both.

Ah, ok. If it's quick, do you mind giving the updated instructions a go? Don't want to promote a best practice that we haven't tried ourselves.

Let me know if trying them isn't quick. I can pull the updated instructions out into a separate story that we can address later.

@noahtalerman
Copy link
Member Author

The deletion step 4 is optional, so we could simply remove it.

Removed it 👍

@noahtalerman
Copy link
Member Author

Decided to merge this.

If we learn that the new instructions don't work we can quickly update.

@noahtalerman noahtalerman merged commit 9bf5f27 into main Nov 7, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants