Skip to content

Editing Guide for Quantum Computing Class Site

This guide provides instructions on how to edit and update the content of the Quantum Computing class site hosted on GitHub and built using MkDocs.

  1. Accessing the Repository: To start editing, navigate to the GitHub repository for the site. You can find the link at the top of the page on the class site or here.
  2. Understanding the File Structure: Familiarize yourself with the repository's file structure. Key directories include docs (containing Markdown files for site pages) and papers (holding academic papers and resources).

Updating Different Sections:

Papers

  1. Navigate to the Papers directory in the gitlab repository.
  2. Upload the PDF or document file.
  3. Go to Papers.md located in the docs\papers directory of the gitlab repository.
  4. Update the 'Papers.md' file with a link to the new paper using Markdown format. Format:
  5. Example format: [Paper Title](./papers/your_paper_file.pdf) - Brief description or abstract.

Job Listings

  1. Navigate to the Job_listing.md file.
  2. Add new job opportunities using the format provided in the file.

News

  1. Navigate to the News.md file.
  2. Insert new news links following the format in the file (Example at the bottom of the News.md).

Assignments (Labs and Quizzes)

  1. Navigate to the respective directories under Assignments.
  2. Add new lab or quiz files as needed.
  3. Update the Labs.md and Quizzes.md files to link to these new materials.

Other Sections

  • Edit other Markdown files (Applications.md, Advance Topics.md, etc.) directly to add or update content. Follow the existing format for consistency.

Committing Changes to GitHub:

  1. Make Your Changes: Edit or add files as needed.
  2. Commit Your Changes: Use descriptive commit messages to explain what you've updated or added. (If Editing Locally, after committing, push the changes to the GitHub repository.)

Site Update Timeline

  • Once a commit has been pushed to GitHub, the site will take approximately 10 minutes for the changes to appear automatically.

Editing Locally

  1. Clone the Repository: For significant changes or to preview changes live, clone the repository to your local machine.
  2. Local Testing: Use mkdocs serve to run a local server and see your changes instantly.
  3. Push to GitHub: Once satisfied with your changes locally, push them to the GitHub repository.

Note: Always ensure your updates are accurate and relevant to the course. Preview changes before pushing to avoid errors on the live site.

Version Control With Git

This is a good starting point for those new to git and GitHub

Additional Resources