Clean frontmatter after migrating to website #7
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
good first issue
Good for newcomers
help wanted
Extra attention is needed
Clean frontmatter after migrating to website
So, my script definitely achieved its goal of reducing the amount of manual text manipulation.
However, it could only do so much and hence the frontmatter of each course needs to be cleaned
Step 0 - Guidelines
When making a commit, refer to this issue.
git commit -m "Update <course_code> based on #<issue_no>"
By doing this, all commits related to changing the frontmatter will be displayed alongside this issue on GitHub.
Do not accidentally close this issue by doing this
Stick to the order of attributes shown in the above convention.
This will improve the efficiency of maintaining the library
Avoid typos, especially those on proper nouns.
After making a change on your local repository, run the local server and take a look at your change.
If things look good commit and push
There may be junk characters in the strings that need to be removed.
This is due to the inefficiency of the previous method of maintaining the library
If necessary, alter the
title
of a resource so that it makes sense to a user who might not be familiar with theauthor
The
author
of a learning resource can be an individual or an organizationIf the
author
of a learning resource is truly anonymous, that attribute should be left blank.Support for viewing
remarks
is not yet implemented. If you need to further explain a resource add this attribute.Prerequisites
are dead. For now.Step 1 - Code & Title
Ensure that each course has its appropriate
code
&title
in the frontmatterStep 2 - Textbooks
Ensure that the frontmatter array
textbooks
has these attributesStep 3 - Source Code
Ensure that the frontmatter array
source-code
has these attributesHere,
author
is the username of the author on the respective siteStep 4 - Videos
Ensure that the frontmatter array
videos
has these attributesRefer to either single videos or entire playlists
Step 5 - Websites
Ensure that the frontmatter array
websites
has these attributesThis section is meant for any webpage or website that may benefit the user
Step 6 - Articles
Ensure that the frontmatter array
articles
has these attributesStep 7 - Communities
Ensure that the frontmatter array
communities
has these attributesStep 8 - Apps
Ensure that the frontmatter array
apps
has these attributesThe
url
should not discriminate between users of different mobile operating systems.Link to the app's website download page to facilitate both users
The text was updated successfully, but these errors were encountered: