index.html

<!doctype html>

<html lang="en">
<head>
  <meta charset="utf-8">

  <title>ExpOS - User Contributed Content</title>
  <meta name="description" content="User Contributed Content for ExpOS">
  <meta name="author" content="https://github.com/exposnitc">

  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css">
</head>

<body>
<h1>User Contributed Content for ExpOS</h1>

<blockquote><b>Note:</b> This includes content related to both ExpOS (OS Lab) and EXPL (Compiler Lab). Because although they are offered as separate courses at NITC, they are closely related and dependent on each other. </blockquote>

<section>
<h2><a href="https://github.com/eXpOSNitc/user-contrib/">Repo</a></h2>
<h2><a href="./posts.html">Posts</a></h2>
</section>
  
<section>
<h2>Introduction</h2>
<p>
  Every year we have seen students come up with interesting content related to both the courses that are worth sharing. 
  For example, a few students came up with Docker scripts for simplifying the installation procedure. 
  Some students had shared vim and vscode extensions for syntax highlighting SPL files.
</p>
<p>
  The official documentation and the repositories are only updated at the end of each semester after rigorous review, to keep them as stable as possible.
  So we are providing a place here for the students and the community to share their own content.
  These will not be rigorously reviewed. 
  At the end of the semester we will consider the recognition of well made and popular content as official 
  and maintaining them along with other official material.
</p>
</section>

<section>
<h2>How to contribute</h2>
<p>
  The contributers should fork the repo and create a folder corresponding to their github userid inside the /users folder.
  You can put any type of content there. Scripts, programs, cheat sheets, PDFs, etc. 
  The only requirement is that they should be related to ExpOS or EXPL.
</p>
<p>
  Your content may be either a written material, for example a blog post explaining some concept, 
  or something like a program or a script.
</p>
<p>
  If it is of the latter category, we encourage you to also provide a written material explaining how to use it for your fellow students.
</p>
<p>
  A link to thes written material should be added to <a href="https://github.com/eXpOSNitc/user-contrib/blob/main/posts.html">posts.html</a> in the repo.
</p>
<p>
  Written material can be in HTML, PDF or formats like Markdown.
</p>
<p>
  If it is HTML or PDF, find out the public link to it. For example: https://exposnitc.github.io/user-contrib/users/happycoder97/my_writeup.html.
</p>
<p>
  Then add this link to <a href="https://github.com/eXpOSNitc/user-contrib/blob/main/posts.html">posts.html</a>
</p>
<p>
  For Markdown and similar formats you have two options:
<ul>
  <li>You may use a tool like Hugo or pandoc to convert it to HTML.</li>
  <li>Or you may link the GitHub rendered page for it. For example: https://github.com/eXpOSNitc/user-contrib/blob/main/users/happycoder97/my_writeup.md</li>
</ul>
</p>
<p>
  If you feel so, you can use frameworks like VueJS or tools like Hugo to create the HTML file.<br>
  This will be useful for tools like memory address calculators, or cheat sheets with search option.
</p>
<p>
  After you finish your work, you should send a pull request from your fork to the parent repo.
</p>
  
<p>
  After you create the pull request, before merging it, you can add the link to the pull request inside your writeup to accept comments and feedback.
  Users may also vote on your work under the pull request using the 👍 icon.
</p>
</section>

<section>
<h2>Notes to Admins</h2>
<p>You are not required to rigorously check the accuracy of the content provided by users.</p>
<p>Any pull requests that only change the user's own folder should be merged without any delay. Changes to other files should be carefully reviewed.</p>
</section>
</body>
</html>