forked from noodlapp/noodl-docs
-
Notifications
You must be signed in to change notification settings - Fork 1
feat: update version control docs #12
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d93b71e
update: version control docs
alan-x-n 6747114
chore: more edits
alan-x-n 6f90664
Update setup-version-control.md
alan-x-n 9f1be4c
Update overview.md
alan-x-n a34554a
Update docs/guides/collaboration/setup-version-control.md
alan-x-n ad942b2
chore: cleanup of unused files
alan-x-n File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
73 changes: 0 additions & 73 deletions
73
docs/guides/collaboration/migrating-from-noodl-hosted-git.mdx
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| # Setup Version Control | ||
|
|
||
| ## Introduction | ||
|
|
||
| Fluxscape uses Git as its underlying version control system. Version control allows you to: | ||
|
|
||
| - Collaborate with team members | ||
| - Work with multiple versions of a project in parallel (branches) | ||
| - Keep a full history of your project, locally or via a connected Git repository (e.g. GitHub) | ||
|
|
||
| Initializing version control always starts with **local Git**. | ||
| Connecting a remote repository is optional and done separately. | ||
|
|
||
| --- | ||
|
|
||
| ## Requirements | ||
|
|
||
| Before setting up version control, make sure: | ||
|
|
||
| - **Git is installed** on your machine | ||
| Fluxscape relies on your local Git installation. | ||
| - macOS: Git is usually preinstalled | ||
| - Windows: Install from https://git-scm.com | ||
| - Your project is stored in a local folder | ||
| - (Optional) A GitHub account if you want to collaborate or push to a remote repository | ||
|
|
||
| --- | ||
|
|
||
| ## Initialize Version Control (Local Git) | ||
|
|
||
| This is the first step and enables Git **locally only**. | ||
|
|
||
| 1. Open your project in Fluxscape | ||
| 2. Open the **Version Control** panel | ||
| 3. Click **Initialize Version Control (Git)** | ||
|
|
||
| <div className="ndl-image-with-background"> | ||
|
|
||
|  | ||
|
|
||
| </div> | ||
|
|
||
| This will: | ||
| - Initialize Git in your project folder | ||
| - Enable local commits and history | ||
| - Not connect to GitHub or any remote service | ||
|
|
||
| All changes and history remain on your machine until a remote repository is added. | ||
|
|
||
| This setup is ideal for: | ||
| - Solo work | ||
| - Prototyping | ||
| - Working offline | ||
| - Getting started with version control | ||
|
|
||
| --- | ||
|
|
||
| ## Connect a GitHub Repository (Optional) | ||
|
|
||
| Connecting a GitHub repository allows you to collaborate with others and back up your project remotely. | ||
|
|
||
| Before connecting a repository in Fluxscape, make sure you either: | ||
| - Created a GitHub repository, or | ||
| - Were granted full access to an existing repository | ||
|
|
||
| Fluxscape always works with a **local project folder**. If you are connecting to an existing repository, it must be cloned to your machine first. | ||
|
|
||
| --- | ||
|
|
||
| ### Step 1: Choose or create a GitHub repository | ||
|
|
||
| You can connect: | ||
| - An existing GitHub repository (for example, one shared with you by a collaborator), or | ||
| - A newly created empty repository | ||
|
|
||
| :::warning Existing repository requirement | ||
| Fluxscape always works with a local project folder. If you are connecting to an existing project and repository, first clone the repository to your machine, import the project into Fluxscape, and then Open the Project. | ||
| ::: | ||
| --- | ||
|
|
||
| ### Step 2: Set up GitHub authentication | ||
|
|
||
| GitHub requires authentication when pushing or pulling changes. | ||
|
|
||
| Fluxscape uses **GitHub Personal Access Tokens**. | ||
|
|
||
| #### Create a Personal Access Token | ||
| 1. Visit https://github.com/settings/personal-access-tokens (Or go to Github Settings > Developer Settings > Personal Access Tokens) | ||
| <div className="ndl-image-with-background"> | ||
|  | ||
| </div> | ||
| 2. Create a **fine-grained personal access token** | ||
| <div className="ndl-image-with-background"> | ||
|  | ||
| </div> | ||
| 3. Set your Expiration | ||
| 4. Select the repository you want to connect | ||
| 5. Grant **Read & write** access to repository "Contents" | ||
| <div className="ndl-image-with-background"> | ||
|  | ||
| </div> | ||
| 6. Create the Token & Copy the token (it cannot be viewed again) | ||
| <div className="ndl-image-with-background"> | ||
|  | ||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| ### Step 3: Configure the Git remote in Fluxscape | ||
|
|
||
| 1. Open your project in Fluxscape | ||
| 2. Open the **Version Control** panel | ||
| 3. Click Version Control Settings (Gear Icon) | ||
| 4. Find your GitHub Repo Origin URL | ||
| 5. Paste the GitHub Repo Origin URL | ||
| 6. Paste your Personal Access Token into **GitHub Credentials** | ||
| 7. Save | ||
|
|
||
| <div className="ndl-image-with-background"> | ||
|  | ||
| </div> | ||
| <div className="ndl-image-with-background"> | ||
|  | ||
| </div> | ||
|
|
||
| ## Next Steps | ||
|
|
||
| :::note | ||
| Continue to [Using Version Control](./version-control) to learn how to work with commits, syncing, conflicts, and branches. | ||
| ::: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added
BIN
+147 KB
static/docs/guides/collaboration/version-control/git-personal-access-token.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+301 KB
.../docs/guides/collaboration/version-control/github-new-personal-access-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+361 KB
...cs/guides/collaboration/version-control/github-personal-access-token-config.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+89.7 KB
...docs/guides/collaboration/version-control/github-personal-access-token-copy.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-5.57 MB
static/docs/guides/collaboration/version-control/migration-wizard.mp4
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should keep in mind that there is a link on the project page to this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, which project page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For example here: https://github.com/fluxscape/fluxscape?tab=readme-ov-file#note-for-users-who-are-migrating-from-the-deprecated-closed-source-version