search

jvjohnson1 / TheFortress

A secure coding demonstration that is intended to be attacked.
0 stars 0 forks source link

Reminder: fix formatting of design documents #2

Closed pawaitemadisoncollege closed 3 years ago

pawaitemadisoncollege commented 3 years ago

The following need format fixes to improve readability in GitHub:

jvjohnson1 commented 3 years ago

I followed the link you provided on Slack, and modified one file as a test. (I choose ProjectPlan.md) However, it came up on GitHub looking as bad as before.

pawaitemadisoncollege commented 3 years ago

It seems like you are working towards an unordered list?

Compare your code to the example github markdown example. What is different?

Your code:

Screen Shot 2020-09-27 at 7 49 27 AM

Working lists from the github markdown reference:

Screen Shot 2020-09-27 at 7 48 58 AM
jvjohnson1 commented 3 years ago

Fixed it, but spent way to much time, making it unlikely I will finish this week's work by Wednesday. You want us to figure it out ourselves with only small hints, but we need a more efficient way of doing that. I think that should be part of teaching programming, maybe late in the first semester when the last project has some size. By the third term we should be effective problem solvers, without the kind of stress I had this week - and last spring.

pawaitemadisoncollege commented 3 years ago

This looks good now @jvjohnson1 .

I'm sorry that markdown was frustrating for you. I thought the screenshots above showed the difference, which was missing a space between the stars and the text. Was that difficult for you to see in the screenshot format above? How could I have communicated that better?

You can close this up whenever you like!

jvjohnson1 commented 3 years ago

The struggle was that there were numbers and sometimes letters after the items in the example, and I thought that meant those were required. Plus, I kept trying to find a way to put and * in the text (does markdown have an escape character?) so I could show was is MVP.

pawaitemadisoncollege commented 3 years ago

No need to escape it - just put the star at the end of the line. It’s the * at the beginning of a line, followed by a space that denotes it as a bullet.

Here are my demo repo user stories with MVP stories marked with a *.

https://github.com/mad-java-ent-f20/FatBikeTrailReports/blob/master/DesignDocuments/userStories.md

On Sep 27, 2020, at 8:41 PM, jvjohnson1 notifications@github.com wrote:

The struggle was that there were numbers and sometimes letters after the items in the example, and I thought that meant those were required. Plus, I kept trying to find a way to put and * in the text (does markdown have an escape character?) so I could show was is MVP.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fjvjohnson1%2FTheFortress%2Fissues%2F2%23issuecomment-699724935&data=01%7C01%7Cpawaite%40madisoncollege.edu%7Ccef6e941cf9046678ec908d8634fad7a%7C33f001466fcc49e9b5687896b3069d44%7C0&sdata=SlCdCj63qPcR%2FiZeRkbTJiKX7q%2BlH0zSykULlUARZ0g%3D&reserved=0, or unsubscribehttps://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FADJ3KIXF4QVXAIF6KHLM6WTSH7SWDANCNFSM4R2QPKUQ&data=01%7C01%7Cpawaite%40madisoncollege.edu%7Ccef6e941cf9046678ec908d8634fad7a%7C33f001466fcc49e9b5687896b3069d44%7C0&sdata=glcuS3Cv7Uhy1o%2Bi3X5MZ%2FapB6kvNtCImAaHJ%2BDBXNE%3D&reserved=0.