Style Guide MNJK: Difference between revisions

From ITCwiki
Jump to navigation Jump to search
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Introduction=
=Introduction=
'''''[https://www.youtube.com/watch?v=dQw4w9WgXcQ Watch the video introduction]'''''
This lab assumes that you know the IP address of your Linux system and are connected to the ITCnet VPN network. If you need help with these steps please see [[ITC_VPN_Instructions | the VPN instructions]] and [[Lab_1_mnjk#Installing_sudo_and_checking_your_IP_address | the previous lab]].
This lab assumes that you know the IP address of your Linux system and are connected to the ITCnet VPN network. If you need help with these steps please see [[ITC_VPN_Instructions | the VPN instructions]] and [[Lab_1_mnjk#Installing_sudo_and_checking_your_IP_address | the previous lab]].


In this lab you will perform the following tasks:
In this lab you will perform the following tasks:
*Installing the ''links'' web browser
*Installing the '''links''' web browser
*Installing the [https://httpd.apache.org/ Apache] webserver
*Installing the [https://httpd.apache.org/ Apache] webserver
*Installing [https://www.python.org/ Python] and its dependencies
*Installing [https://www.python.org/ Python] and its dependencies
Line 13: Line 11:
*'''[https://linux.die.net/man/1/ls ls]'''
*'''[https://linux.die.net/man/1/ls ls]'''


=Lab Section Title=
=Lab Procedure=
'''''[https://www.youtube.com/watch?v=dQw4w9WgXcQ Watch the video of this lab]'''''
==Lab Section Titles Should Capitalize First Letters of Words except Prepositions or Conjunctions==
'''''[https://www.youtube.com/watch?v=dQw4w9WgXcQ Video Tutorial - Lab Section Title]''''' <br>
If there is something at the beginning before the numbering starts don't indent it.
<ol>
<ol>
<li> Steps should be numbered using li tags. </li>
<li> Steps should be numbered using '''li''' tags. </li>
* Sub-steps should be bulleted using asterisks
* Sub-steps should be bulleted using asterisks.
* Another sub-step
* Another sub-step.
* Yet another sub-step
* Yet another sub-step.
<li> Step 2. </li>
<li> Step 2. </li>
* Sub-step about Step 2
* Sub-step about Step 2
: ''NOTE: Notes should be indented with a colon, and wrapped in double apostrophes. Also, they should start with the word NOTE capitalized, and end with a period.''
: ''NOTE: Notes should be indented with a colon, and wrapped in double apostrophes. Also, they should start with the word NOTE capitalized, and end with a period.''
<li> This is a step to show how the code tag should be used. To place it on its own line and not within the paragraph, use a colon before it.</li>
<li> This is a step to show how the '''code''' tag should be used. To place it on its own line and not within the paragraph, move it to the next line and place a colon before it.</li>
: <code> mkdir <my_directory> </code>
: <code> mkdir <my_directory> </code>
: ''NOTE: When using a variable name, such as <my_directory>, it should be wrapped in < > to make it stand out. Also, include a br tag after using a code tag to move to the next line.
:''NOTE: When using a variable name in a code tag, such as '''<my_directory>''', it should be wrapped in '''< >''' to make it stand out.
This is how a transition sentence should appear between steps.
This is how a transition sentence should appear between steps.
<li> This is a step to show how to highlight a command, such as '''apt install''' within the step.</li>
<li> This is a step to show how to highlight a command, such as '''apt install''', within the step.</li>
<li> Step 5 </li>
: ''NOTE: If the command is in a note, it will be bold and italicized such as '''apt install'''.''
<li> Example of a multi-line '''pre''' tag. Best for keeping all lines within the same box or for showing indentation. </li>
<pre>
<pre>
If you have multi-line code / printout
If you have multi-line code / printout
Line 36: Line 37:
This is an example of a pre tag.
This is an example of a pre tag.
</pre>
</pre>
<li> Step 6 </li>
<li> This is an example of the same printout, but with '''code''' tags.</li>
: ''NOTE: Each line is a separate box and there is no indentation.''
<code>If you have multi-line code / printout</code><br>
<code>If you have multi-line code / printout</code><br>
<code>  that needs to show indentation for whatever reason,</code><br>
<code>  that needs to show indentation for whatever reason,</code><br>
Line 42: Line 44:
<code>  work better than code tags.</code><br>
<code>  work better than code tags.</code><br>
<code>This is an example of a code tag.</code>
<code>This is an example of a code tag.</code>
= Checking Your Work =
<ol>
<li> Run the following command:
<br>
<code> ls -al /home/jsmith/redteam </code>
* Verify the following directories are present:
*: '''/theplan'''
*: '''/yours'''
*: '''/mine'''
*: '''/ours'''</li>
* Verify the '''redteam''' group owns the '''/ours''' directory.
<li>Run the following command:
<br>
<code> ls -al /home/jsmith </code>
* Verify the '''redteam''' group owns and has write permissions of the '''/redteam''' directory.</li>
<br><br>
<li> Automatically check your results by running this command:</li>
<code><nowiki>
curl https://raw.githubusercontent.com/mnjk-inver/Linux-2480-Rebuild/main/lab_03_test.py | python3
</nowiki></code></ol>
<br><br>
=Web App=
You can check your progress on any of the labs in the ITC-2480 course from a webapp from this link:  <br>
[http://webcheck.itc2480.campus.ihitc.net webcheck.itc2480.campus.ihitc.net]<br>
You must be logged into the campus VPN to use this application.

Latest revision as of 03:46, 25 April 2021

Introduction

This lab assumes that you know the IP address of your Linux system and are connected to the ITCnet VPN network. If you need help with these steps please see the VPN instructions and the previous lab.

In this lab you will perform the following tasks:

  • Installing the links web browser
  • Installing the Apache webserver
  • Installing Python and its dependencies


You will use the following commands:

Lab Procedure

Lab Section Titles Should Capitalize First Letters of Words except Prepositions or Conjunctions

Video Tutorial - Lab Section Title
If there is something at the beginning before the numbering starts don't indent it.

  1. Steps should be numbered using li tags.
    • Sub-steps should be bulleted using asterisks.
    • Another sub-step.
    • Yet another sub-step.
  2. Step 2.
    • Sub-step about Step 2
    NOTE: Notes should be indented with a colon, and wrapped in double apostrophes. Also, they should start with the word NOTE capitalized, and end with a period.
  3. This is a step to show how the code tag should be used. To place it on its own line and not within the paragraph, move it to the next line and place a colon before it.
  4. mkdir <my_directory>
    NOTE: When using a variable name in a code tag, such as <my_directory>, it should be wrapped in < > to make it stand out.
    This is how a transition sentence should appear between steps.
  5. This is a step to show how to highlight a command, such as apt install, within the step.
  6. NOTE: If the command is in a note, it will be bold and italicized such as apt install.
  7. Example of a multi-line pre tag. Best for keeping all lines within the same box or for showing indentation.
  8. If you have multi-line code / printout
       that needs to show indentation for whatever reason
          using pre tags
       work better than code tags.
    This is an example of a pre tag.
    
  9. This is an example of the same printout, but with code tags.
  10. NOTE: Each line is a separate box and there is no indentation.
    If you have multi-line code / printout
    that needs to show indentation for whatever reason,
    using pre tags
    work better than code tags.
    This is an example of a code tag.

    Checking Your Work

    1. Run the following command:
      ls -al /home/jsmith/redteam
      • Verify the following directories are present:
        /theplan
        /yours
        /mine
        /ours
      • Verify the redteam group owns the /ours directory.
    2. Run the following command:
      ls -al /home/jsmith
      • Verify the redteam group owns and has write permissions of the /redteam directory.


    3. Automatically check your results by running this command:
    4. curl https://raw.githubusercontent.com/mnjk-inver/Linux-2480-Rebuild/main/lab_03_test.py | python3



    Web App

    You can check your progress on any of the labs in the ITC-2480 course from a webapp from this link:
    webcheck.itc2480.campus.ihitc.net
    You must be logged into the campus VPN to use this application.