From 76d5b26e1c585d0e3935a9abe66da97fc4f02216 Mon Sep 17 00:00:00 2001 From: EilidhRoss1 <98904290+EilidhRoss1@users.noreply.github.com> Date: Fri, 16 Sep 2022 08:35:42 +0100 Subject: [PATCH] fix errors --- meta/editing.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/meta/editing.md b/meta/editing.md index 8b1d709..982ed4c 100644 --- a/meta/editing.md +++ b/meta/editing.md @@ -1,6 +1,6 @@ # Editing Guide -This is a guide to help people contribute content or manage contribution of content. Focus is on the "wiki" content stored in markdown -- which is all pages except the front page and a few special generated pages e.g. `/all` page. +This is a guide to help people contribute content or manage contribution of content. Focus is on the "wiki" content stored in markdown -- which is all pages except the front page and a few special generated pages e.g. ## Introduction @@ -101,7 +101,7 @@ In this stage, you ‘fork’ the Life Itself Web3 repository, i.e. you make a r In this stage, you ‘clone’ your forked repository, i.e. you copy your forked version of the Life Itself Web3 repo to your computer so that you can make edits on your local machine without affecting the remote git repo. 00:40-01:50 of the [video tutorial](https://drive.google.com/file/d/1mWqXDx6ICJ_1qreoYoB774weWi-AtyDo/view) corresponds to this stage. _If you’ve cloned the forked repo before, skip this stage._ * Search your computer for its ‘terminal’ and open it. The terminal is simply a text-based way of interacting with the computer through commands. In the terminal, you can type commands, manipulate files, execute programs, and open documents. (00:03-00:39) * On your forked repo page (make sure you’re not on the main repo page), click the green ‘Code’ button and copy the HTTPS link -* Type into Terminal cd , where is replaced by the path to the folder you want to navigate to. E.g. “cd Desktop/Folder/life_itself/tutorial”. On a Mac, you can drag the folder to the terminal after typing “cd”. Otherwise, you can find the folder path [Mac](https://www.howtogeek.com/721126/3-ways-to-see-the-current-folder-path-on-mac/#:~:text=Open%20a%20Finder%20window%2C%20and,path%20to%20the%20current%20folder.); [Windows](https://www.wikihow.com/Find-a-File%27s-Path-on-Windows) and type or paste it in manually. +* Type into Terminal cd < directory >, where < directory > is replaced by the path to the folder you want to navigate to. E.g. “cd Desktop/Folder/life_itself/tutorial”. On a Mac, you can drag the folder to the terminal after typing “cd”. Otherwise, you can find the folder path [Mac](https://www.howtogeek.com/721126/3-ways-to-see-the-current-folder-path-on-mac/#:~:text=Open%20a%20Finder%20window%2C%20and,path%20to%20the%20current%20folder.); [Windows](https://www.wikihow.com/Find-a-File%27s-Path-on-Windows) and type or paste it in manually. * What you’re doing here is navigating in Terminal to the folder on your computer where you want to save the cloned repository (i.e. changing the working directory). Normally, on your computer you do this by searching for a folder and clicking on the icon to open it. In Terminal, you do this by typing commands. The command for changing directory is: cd <directory>. (00:40-1:11) * Type into Terminal the command “git clone” and then paste the repo URL you copied. E.g. “git clone https://github.com/life-itself/web3.git”. Press enter. (1:13-1:48) * N.B. When you try this, you may be prompted to install command line developer tools to be able to run git commands, e.g. XCode for Mac. If this is the case, follow the instructions for installation. @@ -110,11 +110,11 @@ In this stage, you ‘clone’ your forked repository, i.e. you copy your forked In this stage, you create a new ‘branch’, or temporary version, of the repository on which to make edits. These edits will later be merged with the main repository branch. -* Navigate in Terminal to the Life Itself Web3 repo which has been cloned to your computer. To do this, type “cd web3” or “cd ” (as in Stage 2). Press enter. (1:49-2:02) +* Navigate in Terminal to the Life Itself Web3 repo which has been cloned to your computer. To do this, type “cd web3” or “cd < directory >” (as in Stage 2). Press enter. (1:49-2:02) * Update your local clone of the remote repository. _You don’t need to do this if you’ve only just cloned the repo just now._ * Type into Terminal “git pull”. Press enter. * Create a branch on which to make edits - * Type “git checkout -b ”. E.g. you might name your branch “edits”. So you would type “git checkout -b edits”. This command will create a new branch and switch you to this branch. N.B. the branch name cannot contain spaces. + * Type “git checkout -b < your_branch_name >”. E.g. you might name your branch “edits”. So you would type “git checkout -b edits”. This command will create a new branch and switch you to this branch. N.B. the branch name cannot contain spaces. ##### Stage 4: Edit @@ -144,8 +144,8 @@ In this stage, you prepare the changes you have made (and saved) to a Markdown f * Go to your computer’s Terminal (4:59-5:08) * Type “git status”. Press enter. (5:09-5:30) -* Type “git add ”. E.g. “git add site/content/test.md”. Press enter. (5:31-6:06) If you’ve edited more than one file, you can type “git add .” to add all the modified files with one command. -* Type “git commit -m “””. E.g. “git commit -m “fix typo”” or “git commit -m “add extra text to definition””. Press enter. Note that the description of the edit must be in double quotation marks. (6:07-7:01) +* Type “git add < name of modified file >”. E.g. “git add site/content/test.md”. Press enter. (5:31-6:06) If you’ve edited more than one file, you can type “git add .” to add all the modified files with one command. +* Type “git commit -m “< description of edit >””. E.g. “git commit -m “fix typo”” or “git commit -m “add extra text to definition””. Press enter. Note that the description of the edit must be in double quotation marks. (6:07-7:01) * Type “git push origin ”, replacing with the name of the branch you create. * Submit your changes for review: Go to your Github repo and click on the “Compare & pull request” button. Add a description and submit the pull request. * Someone from our team will review and confirm the merge. Once they’ve done that, your edit will appear on the site! Thanks for contributing!