How to contribute to iTechX #63
why-in-Shanghaitech
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Contributing to iTechX is easy and simple -- no need to know anything about GitHub, git, or any code. iTechX is equipped with a UI system for contributions!
Step 1. Login to iTechX
To contribute to iTechX, you need to have a GitHub account and login to iTechX. Click '登录' on the top-right corner and follow the instructions.
Step 2. Create Personal Space
Now that you've logined to iTechX, you may create your personal space! Move your mouse to the top right corner, hover at your avatar and click on "进入个人空间".
Move to the bottom of the page, and click '立即开启'.
Wait a few minutes... then everything is done! You'll be redirected to your personal space. You may do whatever you want in your personal space -- only you can visit your space. When you want to contribute, just merge your space to our main site! We'll introduce this later.
If you want to get to your personal space from the main site next time, just follow the same way as you create your personal space. iTechX will automatically detect whether you have already created your personal space, and then redirect you to your space.
Step 3. Maintain Courses
On the dashboard page, you may maintain the courses in the database.
Step 3.1. Create Courses
In your personal space, you may create your own courses! At the bottom of the page, click '添加更多课程':
Then fill in the information based on the instructions.
After everything is done, click '确定' to submit. Then wait for several seconds (or minutes). If you see a green tick indicating that the submission is successfully processed, then refresh the page. You should see that the course appears in the dashboard.
Step 3.2. Edit Courses
For existing courses, you may edit the metadata. Click the gear icon on the left of the button '查看课程', then edit the information.
After everything is done, click '修改' to submit. Then wait for several seconds (or minutes). If you see a green tick indicating that the submission is successfully processed, then refresh the page. You should see that the course information has been modified.
Step 4. Maintain Semesters
On the course page, you may maintain the semesters of this course in the database.
Step 4.1. Create Semesters
At the bottom of the page, click '添加新学期':
Click the gear icon on the left of the button '查看主页'.
Then fill in the information based on the instructions. Your modification will render in real-time.
.01. You may look it up in your school course table:The rules for course number is unknown (seems to be changing through time)... It is fine to use the default number if there's only one class in that semester. You can't change this after creating the course.
unknownif you don't know who the person is.After everything is done, click '添加' to submit. Then wait for several seconds (or minutes). If you see a green tick indicating that the submission is successfully processed, then refresh the page. You should see that the semester appears on the course page.
Step 4.2. Edit Semesters
Quite similar to step 4.1! For the semester card you want to edit, click the gear icon on the left of the button '查看主页'. Then fill in the information based on the instructions. However, your modification will NOT render in real-time.
unknownif you don't know who the person is.After everything is done, click '修改' to submit. Then wait for several seconds (or minutes). If you see a green tick indicating that the submission is successfully processed, then refresh the page. You should see that the semester modified on the course page.
Step 4.3. Upload Course Contents
The contents for each semester are arranged in folders. At the bottom of each semester card, there is a link '新建文件夹'.
A pop-up will let you enter the folder name. There will be hints when you are typing. In most cases, you may choose among the hint folder names, but it is fine to create a new name. You cannot change the folder name after creating it.
The folder won't be created unless you upload files to that folder. To upload files, there're two options:
How does iTechX render files? We will render files with extensions
.md,.mdx,.html,.htmlxin iTechX. Other files will be placed at '浏览文件'. Currently, I'll not introduce how to create a file that will be rendered in iTechX (Too complicated and not quite useful. Maybe I'll build a UI system in the future?). Check the file base of iTechX if you are interested.Step 5. Maintain People
Step 5.1. Add New People
When you're dealing with semesters, you may find that there are people not in the database. Click '没有找到？点这里添加人物' to add new people.
envelope,home,github-alt.For emails, use
envelopeas the icon and usemailto:as the prefix of the link. iTechX will automatically encode the email to prevent attacks.When you click '修改', it will directly forward your modifications to the database. The database will be changed immediately and you cannot undo it through the UI system. You can't remove a person or modify the ID of a person after creating the person.
Step 5.2. Edit Information of the People
If you want to edit an existing person, the only way is to click the ID of the person when editing the semester card. It will show a similar pop-up to that in step 5.1.
envelope,home,github-alt.Step 5.3. Add a Personal Introduction
Click the image of a person, iTechX will open the page of that person.
Most people do not have a personal introduction page, so you'll see 'page not found' on the right. If you'd like to add an introduction for this person, click 'Edit 编辑' at the bottom-right of the page.
It will redirect you to the page in GitHub. Edit the file in Markdown format, then make a commit. Back to iTechX, the page will render on the page of that person.
Everyone could have a personal page even if he/she is not an instructor or teaching assistant, as long as he/she exists in the database. The link follows the format:
i-techx.github.io/iTechX/people?pid={ID}.Step 5.4. Edit a Personal Introduction
To edit the personal introduction, follow the same instructions in step 5.3.
Step 6. Merge to Main Site
Hover at your avatar at the top-right of the page. Click '合并至主站'. It will redirect you to the merge procedure. To review the requests in a shorter time, you're required to describe what you did for this merge.
Step 7. Switch between Personal Space and Main Site
To get back to the main site, click the link to the right of the dashboard page.
To get to your personal space from the main site, just follow the same steps as you create your personal space. iTechX will automatically detect whether you have already created your personal space, and then redirect you to your space.
Beta Was this translation helpful? Give feedback.
All reactions