-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathindex.html
More file actions
64 lines (36 loc) · 19.6 KB
/
index.html
File metadata and controls
64 lines (36 loc) · 19.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width">
<meta name="generator" content="Docusaurus v2.0.0-alpha.54">
<title data-react-helmet="true">Editing a Tutorial | CodeRoad</title>
<meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:title" content="Editing a Tutorial | CodeRoad"><meta data-react-helmet="true" name="description" content="Once you've created a tutorial, you'll need a way to version and update new releases."><meta data-react-helmet="true" property="og:description" content="Once you've created a tutorial, you'll need a way to version and update new releases."><meta data-react-helmet="true" property="og:url" content="https://coderoad.github.io/docs/edit-tutorial">
<link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico">
<link rel="stylesheet" href="/styles.83769add.css">
<link rel="preload" href="/styles.6183a4c7.js" as="script">
<link rel="preload" href="/runtime~main.43d363e4.js" as="script">
<link rel="preload" href="/main.27f489e0.js" as="script">
<link rel="preload" href="/1.7cdaee68.js" as="script">
<link rel="preload" href="/2.ba088b65.js" as="script">
<link rel="preload" href="/24.83b42a38.js" as="script">
<link rel="preload" href="/20ac7829.c1d3de96.js" as="script">
<link rel="preload" href="/17896441.644fecbe.js" as="script">
<link rel="preload" href="/1ba3b2e6.4db932d1.js" as="script">
</head>
<body>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=window.matchMedia("(prefers-color-scheme: dark)"),n=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();null!==n?t(n):e.matches&&t("dark")}()</script>
<div id="__docusaurus">
<nav class="navbar navbar--light navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/"><img class="navbar__logo" src="/img/logo.svg" alt="CodeRoad Logo"><strong class="navbar__title">CodeRoad</strong></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/overview">Docs</a></div><div class="navbar__items navbar__items--right"><a target="_blank" rel="noopener noreferrer" href="https://github.com/coderoad/coderoad-vscode" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_1gtM"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_keGJ moon_1gwN"></span></div><div class="react-toggle-track-x"><span class="toggle_keGJ sun_3CPA"></span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img class="navbar__logo" src="/img/logo.svg" alt="CodeRoad Logo"><strong class="navbar__title">CodeRoad</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link navbar__link--active" position="left" href="/docs/overview">Docs</a></li><li class="menu__list-item"><a target="_blank" rel="noopener noreferrer" href="https://github.com/coderoad/coderoad-vscode" class="menu__link" position="right">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1kjD"><div class="docSidebarContainer_1cYp"><div class="sidebar_1kLs"><div class="menu menu--responsive menu_w2sC"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_2vk4" xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 32 32" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Intro</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/overview">Overview</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/setup">Setup</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/how-coderoad-works">How CodeRoad Works</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">Build</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/build-tutorial">Building a Tutorial</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/create-a-practice-tutorial">Create a Practice Tutorial</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/config-docs">Config</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/hooks-actions">Hooks & Actions</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/test-runner">Test Runner</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/init-commit">Init Commit</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/test-examples">Test Examples</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active" tabindex="0" href="/docs/edit-tutorial">Editing a Tutorial</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/examples">Examples</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/starters">Starters</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Development</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/development">Development</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/env-vars">Env Variables</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">More</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/inspiration">Inspiration</a></li></ul></li></ul></div></div></div><main class="docMainContainer_FFX1"><div class="container padding-vert--lg docItemWrapper_1cc7"><div class="row"><div class="col docItemCol_2GOA"><div class="docItemContainer_2cwg"><article><header><h1 class="docTitle_1vWb">Editing a Tutorial</h1></header><div class="markdown"><p>Once you've created a tutorial, you'll need a way to version and update new releases.</p><p>Tutorials are made of two parts: Markdown & Git commits.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="1-editing-markdown"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#1-editing-markdown" title="Direct link to heading">#</a>1. Editing Markdown</h3><p>When editing markdown, simply edit the markdown and re-run the builder.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="2-editing-git-commits"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#2-editing-git-commits" title="Direct link to heading">#</a>2. Editing Git Commits</h3><p>Editing Git commits is a bit harder, and involves a part of Git called an "interactive rebase".</p><ol><li>Create a new branch and give it a versioned named, like "v0.2". It's important to create a new branch as we will be changing the git commit history.</li></ol><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-shell codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> checkout -b v0.2</span></div></div></div></div></div><ol start="2"><li>Start an interactive rebase.</li></ol><p>When editing code, you'll need to rebase. You can use VSCode as your default editor for Git: <a href="https://blog.soltysiak.it/en/2017/01/set-visual-studio-code-as-default-git-editor-and-diff-tool/.">https://blog.soltysiak.it/en/2017/01/set-visual-studio-code-as-default-git-editor-and-diff-tool/.</a></p><p>Run rebase starting at a commit target, or just from the start with <code>--root</code>.</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-shell codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> rebase -i --root</span></div></div></div></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="editing-a-commit"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#editing-a-commit" title="Direct link to heading">#</a>Editing A Commit</h3><p>Choose the commit you want to edit</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-text codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick b73feaf INIT</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick 0a3aa83 1.1</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick 0d67935 2.1</span></div></div></div></div></div><p>Let's say we want to edit step <code>1.1</code> Change the word pick to "edit" or "e"</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-text codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">e 0a3aa83 1.1</span></div></div></div></div></div><p>Save the modified rebase summary file and your rebase will start. Git will run through the commits until the first flagged "edit", then stop at the commit.</p><p>Make the file changes you planned, then "add" your changes to git.</p><p>To complete rebasing:</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-shell codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> rebase --continue</span></div></div></div></div></div><p>If you encounter any merge conflicts along the way, resolve them, add the changes and continue as above.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="adding-additional-commits"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#adding-additional-commits" title="Direct link to heading">#</a>Adding Additional Commits</h3><p>Let's say we wanted to add an additional commit after the <code>1.1</code>.</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-text codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick b73feaf INIT</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick 0a3aa83 1.1</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick 0d67935 2.1</span></div></div></div></div></div><p>To cause the rebase to pause after a commit, use the word "break" or "b".</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-text codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick b73feaf INIT</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick 0a3aa83 1.1</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">break</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick 0d67935 2.1</span></div></div></div></div></div><p>Save the rebase summary file to start the process. The process should stop at the "break".</p><p>Add the commits you want, and when you finish continue:</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-shell codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> rebase --continue</span></div></div></div></div></div><p>If you encounter any merge conflicts along the way, resolve them, add the changes and continue as documented in the "editing a commit" section.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="rewording-a-commit"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#rewording-a-commit" title="Direct link to heading">#</a>Rewording a Commit</h3><p>Let's say we wanted to change the title of commit "2.1" to "1.2".</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-text codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick b73feaf INIT</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick 0a3aa83 1.1</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick 0d67935 2.1</span></div></div></div></div></div><p>You can use the "reword" or "r" method.</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-text codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick b73feaf INIT</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">pick 0a3aa83 1.1</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">reword 0d67935 2.1</span></div></div></div></div></div><p>When you're finished, just save the file and the commits will be updated.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="oops-something-went-wrong"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#oops-something-went-wrong" title="Direct link to heading">#</a>Oops! Something Went Wrong</h3><p>Rebasing is a difficult skill to master, but you can get good at it with time. That said, time travelling is a complicated process and a lot can go wrong.</p><p>If something goes wrong during your rebase, you can abort by running:</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-shell codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> rebase --abort</span></div></div></div></div></div><p>It's best to only run rebase on new branches so that you'll always be able to get back to your last working version.</p></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/coderoad/coderoad-vscode/edit/master/docs/docs/edit-tutorial.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/test-examples"><div class="pagination-nav__link--sublabel">Previous</div><div class="pagination-nav__link--label">« Test Examples</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/examples"><div class="pagination-nav__link--sublabel">Next</div><div class="pagination-nav__link--label">Examples »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_TbNY"><ul class="contents contents__left-border"><li><a href="#1-editing-markdown" class="contents__link">1. Editing Markdown</a></li><li><a href="#2-editing-git-commits" class="contents__link">2. Editing Git Commits</a></li><li><a href="#editing-a-commit" class="contents__link">Editing A Commit</a></li><li><a href="#adding-additional-commits" class="contents__link">Adding Additional Commits</a></li><li><a href="#rewording-a-commit" class="contents__link">Rewording a Commit</a></li><li><a href="#oops-something-went-wrong" class="contents__link">Oops! Something Went Wrong</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="text--center"><div>Copyright © 2020 CodeRoad. Built with Docusaurus.</div></div></div></footer>
</div>
<script src="/styles.6183a4c7.js"></script>
<script src="/runtime~main.43d363e4.js"></script>
<script src="/main.27f489e0.js"></script>
<script src="/1.7cdaee68.js"></script>
<script src="/2.ba088b65.js"></script>
<script src="/24.83b42a38.js"></script>
<script src="/20ac7829.c1d3de96.js"></script>
<script src="/17896441.644fecbe.js"></script>
<script src="/1ba3b2e6.4db932d1.js"></script>
</body>
</html>