RhinoSecurityLabs / cloudgoat

CloudGoat is Rhino Security Labs' "Vulnerable by Design" AWS deployment tool
BSD 3-Clause "New" or "Revised" License
2.92k stars 612 forks source link

docs: Add dollar sign to indicate that it is a shell script #253

Closed Yaminyam closed 4 months ago

Yaminyam commented 6 months ago

Overview of Changes

For document unity, a dollar sign was added to indicate that it is a shell script.

andrew-aiken commented 6 months ago

Thanks for working on the document unity. Personally I think that its better to not have the dollar sign in front of them since it causes issues when copy/pasting.

Yaminyam commented 6 months ago

@andrew-aiken Your opinion makes a lot of sense too! So, would it be better to unify it by removing existing dollar signs?

andrew-aiken commented 6 months ago

That would make sense (at least for code blocks)

@jdearmas whats your opinion on this?

TeneBrae93 commented 4 months ago

Hey @Yaminyam -- sorry for the late response on this. I agree with @andrew-aiken. I think it's better to not have the dollar sign due to copy/pasting issues (I've ran into that myself on other projects). It would be good to remove the dollar sign for consistency.