From 02b3c9145b06a36bbdd78ee188c86fea0b1b1730 Mon Sep 17 00:00:00 2001 From: kotte Date: Tue, 23 Jan 2024 13:22:29 +0100 Subject: [PATCH] Feat: Add notices of creating empty git repos (#64) --- .../collaboration/migrating-from-noodl-hosted-git.mdx | 4 ++++ docs/guides/collaboration/version-control.md | 8 ++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/guides/collaboration/migrating-from-noodl-hosted-git.mdx b/docs/guides/collaboration/migrating-from-noodl-hosted-git.mdx index 2fea524..3eba380 100644 --- a/docs/guides/collaboration/migrating-from-noodl-hosted-git.mdx +++ b/docs/guides/collaboration/migrating-from-noodl-hosted-git.mdx @@ -56,6 +56,10 @@ This is found in the repo in the "Quick Setup" section: +:::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. diff --git a/docs/guides/collaboration/version-control.md b/docs/guides/collaboration/version-control.md index 77b8293..f8e6ac3 100644 --- a/docs/guides/collaboration/version-control.md +++ b/docs/guides/collaboration/version-control.md @@ -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