adding-a-project

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Adding a Project

添加项目

Overview

概述

When a new project is created, it needs to be added to both the personal site (arjit-me) and the resume (arjit-resume), then made live.
当创建新项目后,需要将其添加到个人网站(arjit-me)和简历(arjit-resume)中,然后上线。

Locations

文件位置

  • Site projects:
    ~/repos/arjit-me/lib/projects.ts
  • Resume projects:
    ~/repos/arjit-resume/resume/projects.tex
  • Resume PDF:
    ~/repos/arjit-resume/arjit_jaiswal_resume.pdf
    (symlinked to
    ~/Documents/arjit_jaiswal_resume.pdf
    )
  • 网站项目列表
    ~/repos/arjit-me/lib/projects.ts
  • 简历项目列表
    ~/repos/arjit-resume/resume/projects.tex
  • 简历PDF文件
    ~/repos/arjit-resume/arjit_jaiswal_resume.pdf
    (已软链接到
    ~/Documents/arjit_jaiswal_resume.pdf

Process

操作流程

  1. Add to
    lib/projects.ts
    in arjit-me:
    • Add a new entry to the
      projects
      array
    • Set
      featured: false
      unless told otherwise
    • Use the repo slug for
      id
      , but a human-readable name for
      title
      on the site is fine either way
  2. Add to
    resume/projects.tex
    in arjit-resume:
    • Add a
      \projectentry{Name}{url}{description}{tech}{date}
    • Always use human-readable names, not repo slugs (e.g. "Arjit Skills" not "arjit-skills")
    • Keep descriptions concise (one line)
    • Insert in chronological order (newest first)
  3. Compile the resume PDF:
    bash
    cd ~/repos/arjit-resume
    make build
    The symlink at
    ~/Documents/arjit_jaiswal_resume.pdf
    auto-updates.
  4. Push the site live:
    bash
    cd ~/repos/arjit-me
    git add lib/projects.ts
    git commit -m "Add <project-name> to projects"
    git push origin main
  1. 在arjit-me的
    lib/projects.ts
    中添加项目
    • projects
      数组中添加新条目
    • 除非另有说明,否则设置
      featured: false
    • id
      使用仓库slug,网站上的
      title
      可以使用人类可读名称,两种方式均可
  2. 在arjit-resume的
    resume/projects.tex
    中添加项目
    • 添加
      \projectentry{Name}{url}{description}{tech}{date}
    • 务必使用人类可读名称,而非仓库slug(例如使用“Arjit Skills”而非“arjit-skills”)
    • 描述需简洁(一行内容)
    • 按时间倒序插入(最新项目在前)
  3. 编译简历PDF
    bash
    cd ~/repos/arjit-resume
    make build
    软链接
    ~/Documents/arjit_jaiswal_resume.pdf
    会自动更新。
  4. 推送网站代码以上线
    bash
    cd ~/repos/arjit-me
    git add lib/projects.ts
    git commit -m "Add <project-name> to projects"
    git push origin main

Rules

规则

  • Resume uses human-readable names; site can use either.
  • Always compile the PDF after resume changes.
  • Always push arjit-me to main to deploy.
  • 简历需使用人类可读名称;网站可任选其一。
  • 修改简历后务必编译PDF。
  • 务必将arjit-me推送到main分支以完成部署。