open-learning-exchange.github.io
open-learning-exchange.github.io copied to clipboard
open-learning-exchange
Wrong Link for Preview Changes Locally
Problem
On page Github Issues, under the title "Preview Changes Locally", there is a link how to preview changes which directs to a mdwiki page that has nothing to do with previewing changes locally.
Steps to reproduce the problem
Go to page Github Issues, scroll down to the title "Preview Changes Locally", and click on the link how to preview changes.
Screenshots
Github Issues page:
The current link page:
Proposed solution
Replace the link url with https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository, or any other better link that authorized team members agree upon.
@siqiuma That is actually the correct link although the tutorial is not as good. Also, I am not so sure about the link you provided.
@siqiuma That is actually the correct link although the tutorial is not as good. Also, I am not so sure about the link you provided.
Thank you for your comment Chirag. This might be a dumb question, but would you please explain a little bit how I can preview changes locally based on the information on the page about opening mdwiki.html? Thank you very much for helping me understand this.
@siqiuma The same way you use to view mdwiki.html (According to the tutorial on the page, using a local HTTP server or the other option to review your changed webpage). Also, I did not find the tutorial that good. I suggest you to search for one that is better if you want to, which will also solve the problem you created this issue originally for.
Thank you Chirag for your help. I finally understand what the mdwiki page is trying to let me know. I haven't got any luck in searching for a better tutorial so far. Since I'm not sure if I will be the only person who gets confused by reading this section, I would suggest make some changes to the instructions on the Github Issues page like the following: Original:
Preview Changes Locally
After making modifications to your local files and before making a commit, you would want to preview the changes locally. The following link, how to preview changes, gives all the information about how to preview changes from your machine. There's also another option to preview using online environment. This link takes you to the online environment.
After change:
Preview Changes Locally
After making modifications to your local files and before making a commit, you would want to preview the changes locally. The following link, how to preview changes, gives all the information about how to open the file(s) you made changes to locally to preview the changes from your machine. (If you are using Mac, you may also drag the file from Finder to the address line in your browser to view the file.) There's also another option to preview using online environment. This link takes you to the online environment.
-- Note: I used bold for the sentences that I changed.
Please let me know if this solution is acceptable, and if I can work on this issue based on this solution. Thank you very much!
