Skip to content

creating Wiki instructions

Jump to bottom
Michelle Shannon edited this page Sep 3, 2021 · 19 revisions

checklist for creating Wiki instructions

Step 1: navigate to the GitHub Repository

  1. login to GitHub

  2. navigate to the spec-lumber repository

  3. navigate to the Wiki within the spec-lumber repository

    • NOTE: you should see the "edit" and "New Page" button towards the top right of the screen if you have editing access to the repository. If you don't have editing access, you'll need to contact DDS to add you to the repository.

Step 2: create a new Wiki page

  1. click on the "New Page" button at the top right of the screen

It will take you to a new screen to create a new page in an editor. This editor uses Markdown language. See this Basic Syntax guide for a refresher. * NOTE: a hack to format new instructions the same way as old instruction is to navigate to another page that's already written and hit "Edit" to see the Markdown syntax used to create that page. However, you must be cautious to not accidentally edit that page while it's open...

Step 3: add screenshots to the repository

To add screenshots to Wiki instructions, you'll need GitHub Desktop and Visual Studio Code. Please note that adding screenshots to the "Assets" folder means you can link to them but they will not show up on the Harvester as a digital object!

  1. fetch origin from spec-lumber repository in GitHub Desktop
    • Open GitHub Desktop
    • Set "Current Repository" to "spec-lumber"
    • click "fetch origin"

  1. open Visual Studio Code
    • open GitHub Desktop and click "Open in Visual Studio Code." This will open the spec-lumber repository in Visual Studio Code

  1. open Windows File Explorer and navigate to Documents/GitHub/spec-lumber/assets/img. This is where you'll add all your screenshots!
    • NOTE: remember that since this folder is a local copy of the GitHub repository, you'll need to stage, commit, and push your changes (which is adding new digital objects) at the end

Step 4: stage your changes

    1. Go to the Source Control view in Visual Studio Code

  1. click on the "+" (plus) symbol to stage your changes

Step 6: commit your changes

  1. once your changes are staged, add a descriptive message about what your changes are. Then click on the "checkmark" to commit your changes to your local GitHub repository on your local machine

Step 7: push your changes

  1. open GitHub Desktop. You should see your descriptive message on the bottom left. If you've committed changes by accident, you can undo your commit here. If you want to push your commit, click on "Push Origin" at the top. This will push your commits to the cloud GitHub Repo, and will make your changes live on the Harvester website in approx. 5-10 minutes.

Step 8: include screenshots in the Wiki

  1. go back to the spec-lumber repository and navigate to your new Wiki page. Open the editor.

  2. The include command in the Wiki editor is: ![](https://harvester.lib.uidaho.edu/assets/img/image.jpg)

    • NOTE: the "image.jpg" at the end of the include is just the file and extension of whatever file you're pointing to.
    • NOTE: the extension is case-sensitive. If your file is .JPG and you write .jpg in the include command, it won't work.

Step 9: link to specific steps

  1. to link to a specific step, exit the editor by clicking on "Save Page" at the bottom and view the page as you normally would. Hover over the "Step" (or any other Heading) you want to link to, and you'll see a little link icon pop up on the left side of the Heading. Click on that link and it will change the URL to go to that part of the page. Copy the URL, open the Wiki editor again, and paste the link to hyperlink text in Markdown format.

Clone this wiki locally