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

[Docs] Mention need to create an initial git commit #3520

Closed
2 tasks done
tsheiner opened this issue Mar 22, 2023 · 4 comments
Closed
2 tasks done

[Docs] Mention need to create an initial git commit #3520

tsheiner opened this issue Mar 22, 2023 · 4 comments
Assignees
Labels
backlogged For internal use. Reserved for contributor team workflow. documentation Improvements or additions to documentation good first issue Good for newcomers scipy-2023
Milestone

Comments

@tsheiner
Copy link
Contributor

Description

Minor issue.

At this point in Getting Started, you'll get an error unless you've created at least one git commit, which the narrative never explicitly tells you to do.

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@tsheiner tsheiner added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Mar 22, 2023
@welcome
Copy link

welcome bot commented Mar 22, 2023

Thank you for opening your first issue here! 🛠

@cosmicBboy
Copy link
Contributor

hi @tsheiner, the referenced guide has a Prerequisites admonition that assumes that the user has following the previous guide on creating a flyte project, which does tell the user to initialize a git repository:

image

Feel free to suggest a way that this can be made clearer!

@tsheiner
Copy link
Contributor Author

Yes, understood. I believe the issue is not about init'ing a repo in the directory but that the user must also do at least one commit. Sounds obvious in retrospect but I missed it and as a result had trouble figuring out why I was getting an error when trying to follow the instructions to register my project:

(my_project) ➜  my_project git:(main) ✗ flytectl register files \
    --project flytesnacks \
    --domain development \
    --archive flyte-package.tgz \
    --version "$(git rev-parse HEAD)"
fatal: ambiguous argument 'HEAD': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git <command> [<revision>...] -- [<file>...]'
INFO[0000] [0] Couldn't find a config file []. Relying on env vars and pflags. 
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x2 addr=0x0 pc=0x105df4a64]

@eapolinario eapolinario removed the untriaged This issues has not yet been looked at by the Maintainers label Mar 24, 2023
@eapolinario eapolinario added this to the 2023 Backlog milestone Mar 24, 2023
@samhita-alla samhita-alla added the good first issue Good for newcomers label Jul 18, 2023
@neverett neverett added the backlogged For internal use. Reserved for contributor team workflow. label Dec 1, 2023
@neverett neverett self-assigned this Dec 1, 2023
@neverett
Copy link
Contributor

neverett commented Dec 4, 2023

Addressing this in flyteorg/flytesnacks#1266

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlogged For internal use. Reserved for contributor team workflow. documentation Improvements or additions to documentation good first issue Good for newcomers scipy-2023
Projects
None yet
Development

No branches or pull requests

6 participants