|
| 1 | +# Install Git: |
| 2 | + |
| 3 | +Goto https://git-scm.com/download/ and download Git for windows or Mac or Linux/Unix. |
| 4 | + |
| 5 | +Install Git with the recommended settings. |
| 6 | + |
| 7 | +# Install Visual studio Code: |
| 8 | + |
| 9 | +Goto https://code.visualstudio.com/download and download Git for windows or Mac or Linux/Unix. |
| 10 | + |
| 11 | +Install VS code with the recommended settings. |
| 12 | + |
| 13 | +# Install Node JS: |
| 14 | + |
| 15 | +Goto https://nodejs.org/en/download/ for the respective OS. |
| 16 | + |
| 17 | +Install Node JS with the default settings. |
| 18 | + |
| 19 | +# GITHUB setup: |
| 20 | + |
| 21 | +1. Goto https://github.com/ and create a new account using sign-up. |
| 22 | + |
| 23 | +## Setup SSH key: |
| 24 | + |
| 25 | +1. Open Git Bash window. |
| 26 | +2. Enter ssh-keygen -t ed25519 -C [email protected] |
| 27 | +3. Enter file in which to save the key -> prefer to the default location as it does not give access error in further steps. |
| 28 | +4. Enter passphrase and the ssh public and private keys are generated on the specified location. |
| 29 | +5. Next add the SSH key to Git Hub. |
| 30 | + Reference: https://docs.github.com/en/[email protected]/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account |
| 31 | + |
| 32 | + - Login to https://github.com/ with your credentials. |
| 33 | + - Copy the SSH public key to your clipboard. |
| 34 | + - In the upper-right corner of any page, click your profile photo, then click Settings. |
| 35 | + - In the user settings sidebar, click SSH and GPG keys. |
| 36 | + - Click New SSH key or Add SSH key. |
| 37 | + - In the "Title" field, add a descriptive label for the new key. |
| 38 | + - Paste your key into the "Key" field. |
| 39 | + - Click Add SSH key. |
| 40 | + - If prompted, confirm your GitHub Enterprise Server password. |
| 41 | + |
| 42 | +## Get the clone URL: |
| 43 | + |
| 44 | +1. Then goto https://github.com/virtualansoftware on a new browser tab. |
| 45 | +3. GO down the page and click on the project 'tutorials'. |
| 46 | +4. If you have logged in Github you will see a button 'Fork' in the top right corner of the page. |
| 47 | +5. Then click on the green button 'Code' and copy the ssh Url. |
| 48 | + [email protected]:< GitHub username>/tutorials.git |
| 49 | + |
| 50 | +# Install docsify: |
| 51 | + |
| 52 | +1. Create a folder on any location you prefer. This will be used to edit the tutorials page. |
| 53 | +2. Right click and select 'Git Bash Here'. |
| 54 | +3. Git bash window will open. |
| 55 | +4. Run the below commands one after another. |
| 56 | + - git clone [email protected]:< username>/tutorials.git |
| 57 | + - npm i docsify-cli -g |
| 58 | + - cd tutorials/ |
| 59 | + - docsify serve docs |
| 60 | +5. Open a browser and goto http://localhost:3000/#/ and you can open Virtualan page. |
| 61 | + |
| 62 | +# To Edit tutorials page: |
| 63 | + |
| 64 | +1. Open Visual studio code window. |
| 65 | +2. click File menu -> Open Folder |
| 66 | +3. Goto Folder you created to install docsify\Git\tutorials and click Select Folder. |
| 67 | + 4. Once you slelect the Tutorials folder, all the paged will be displayed on the Explorer window. |
| 68 | + |
| 69 | +As you start to EDIT on the Visual studio code window refresh the browser to see the changes (http://localhost:3000/#/). |
| 70 | + |
| 71 | +# How to COMMIT the changes: |
| 72 | +1. Exit out of the Git Bash running command Listening at http://localhost:3000 |
| 73 | +2. Run the below commands for the first time when you commit the changes. |
| 74 | + git config --global user.email " [email protected]" |
| 75 | + git config --global user.name "Your Name" |
| 76 | +3. Run |
| 77 | + git commit -am "updated" |
| 78 | + Add appropriate comments inside the "". |
| 79 | +4. Then Run |
| 80 | + git push |
| 81 | + |
| 82 | +# Create PULL request: |
| 83 | +1. Go to "https://github.com/<username>/tutorials/pulls" to create a New Pull request. |
| 84 | +2. Click on the Green "New Pull Request" button to create a new request between your master branch to Virtualan Master branch. |
0 commit comments