Skip to content

Commit

Permalink
Feat: Add notices of creating empty git repos (#64)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrtamagotchi authored Jan 23, 2024
1 parent 5c73860 commit 02b3c91
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/guides/collaboration/migrating-from-noodl-hosted-git.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ This is found in the repo in the "Quick Setup" section:

</div>

:::note
Noodl will clear out the newly created repo when pushing. However, to be on the safe side, make sure to create the repo without any `README.md` or `.gitignore` files.
:::

### Personal Access Token

This is managed in your Github account settings. You can find a guide on it [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token). The token can be set up to access all your repos, or a select few. Usually, allowing access to all repos is fine, but there are some security benefits in creating separate tokens for each repo. Do what works best for you, but make sure your token is able to access your newly created repository.
Expand Down
8 changes: 6 additions & 2 deletions docs/guides/collaboration/version-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,17 @@ This will set up all necessary files to run Git in your project. From here you c

Pushing to an external repo can be done by clicking the button labeled "To push changes set a git remote". You can also use the terminal, or a Git client like [Github Desktop](https://desktop.github.com/).

:::note
:::tip
If you're new to Git, don't forget to push your changes regularly to prevent losing your work. A good rule of thumb is to do it everytime you finish or change a feature.
:::

Any project collaborators will have to clone the project from the repo, and then open the downloaded Project Folder in Noodl.

> The easiest way to get started with Git is through Github. Read more about creating Github repos [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/quickstart-for-repositories) or cloning Github repos [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
The easiest way to get started with Git is through Github. Read more about creating Github repos [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/quickstart-for-repositories) or cloning Github repos [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).

:::note
Noodl will clear out the newly created repo when pushing for the first time. However, to be on the safe side, make sure to create the repo without any `README.md` or `.gitignore` files.
:::

## The version control panel

Expand Down

0 comments on commit 02b3c91

Please sign in to comment.