tcet-opensource/documentation

Official Documentation of all TCET Open Source Projects

documentation's Issues

[TL] - Installation Steps Component

[FMC] - Cycle's Result Section

add tcet linux docs

Document T&P website (Frontend)

Document the workflow of T&P site, the work done by the team from low fidelity diagram to frontend coding till date.

[WIP] Resources Section

This issue tracks adding resources to docs.

document activity dekho

Document

1. Directory structure
2. APIs/API Calls

@JayeshVP24 @vish-rt you can add points if you want

Fixing Collapsible Property in Sidebar

• The sidebar doesnt seem to follow the collapsible property.
• As the projects will increase by time, the sidebar will keep getting big and we need to solve this ASAP.

[FMC] - Header and Help Section

Create Projects Section for TCET Open Source Website

->Check Figma for correct fonts and colors
->Make your branch name as issue_number-projects-section
->It should be responsive

Deploy staging and blogs branches

Parallax scroll effect on Hero Images

Parallax Effect for interactivity

Feel good stuff

The UFO, Rocket and Astronaut.
Make a parallax scroll effect for those...

Find a react library which does it
or pure CSS if u prefer it that way.

Good luck figuring it out, react out to us if u want any help.

[TL] - Hero Component

Document Docs website

Write about Docusaurus, the changes made in the navbar, sidebars, progress on the landing page, file structure, etc.

[FMC] - Getting Started

[TL] - Verify Downloads Component

[TL] - Getting Started

Document ERP

Document the workflow of the ERP, requirement analysis, database schema designed, work done till date.

add tnp site figma diagram

https://www.figma.com/proto/BAJxuC9n4YgOLRQFAe5q65/tnp-tcet?page-id=0%3A1&node-id=1-2&viewport=276%2C458%2C0.55&scaling=scale-down

[TL] - Footer Component

configure docusaurus themeing

Changes made

Document Fill My Cycle Website

Add fill my cycle documentation based on @TejasNair9977's notes.

[FMC] - Mathematical Logic Scripts

Working

The whole thing that I wrote in that documentation was simply how the average marks changes the position of the tick marks. A gist of this is:-

• The average of the marks you enter get converted into 5 different categories, TK, TD, LI, B, C, which are worth 30, 30, 10, 10, 20 marks respectively.

  • These categories have 5 ranks: E, VG, G, A, BA

  • E is the best (Excellent) and BA is the worst(Below Average)

  • You can simply consider these ranks as multipliers.

  • A tick on BA for TK would be worth 6 marks, a tick on E for LI would be worth 10 marks, a tick for TD on G will be worth 18 marks. The logic for the same is:

    • TK is worth 30 marks, and since it has 5 ranks as specified above, an E would be worth 30 marks, which is the best marks you can get, and a BA would be worth 6 marks, which is the worst possible score you can get in this category.
    • TD is also worth 30 marks, and since it has 5 ranks as specified above, an E would be worth 30 marks, which is the best marks you can get, and a BA would be worth 6 marks, which is the worst possible score you can get in this category.
    • LI is worth 10 marks, and since it has 5 ranks as specified above, an E would be worth 10 marks, which is the best marks you can get, and a BA would be worth 2 marks, which is the worst possible score you can get in this category.
    • B is worth 10 marks, and since it has 5 ranks as specified above, an E would be worth 10 marks, which is the best marks you can get, and a BA would be worth 2 marks, which is the worst possible score you can get in this category.
    • C is worth 20 marks, and since it has 5 ranks as specified above, an E would be worth 20 marks, which is the best marks you can get, and a BA would be worth 4 marks, which is the worst possible score you can get in this category.

  • So, with this logic, we can say that we are simply multiplying the worst score by a multiplier, where BA is x1, A is x2, G is x3, VG is x4, E is x5. So, if we want to calculate the marks for a tick on G for TD, we have to multiply its worst score, i.e. 6, by a multiplier of x3, and hence we get 18.

• Now, we could beg the question of how average marks affect these columns. This is, after all, the main part of my trial and error testing.
  • I started off with 0 and saw that the worst possible marks we could get were 20. This is when TD, TK, LI, B, C, all have a rank of BA, therefore giving us marks of 6+6+2+2+4
  • When I made the marks 21, it rounded itself off to 22, and the only tick mark that moved was LI, from BA to A.

	E	VG	G	A	BA	Marks
TD					🗸	6
TK					🗸	6
LI				🗸		4
B					🗸	2
C					🗸	4

• When I made the marks 23, it rounded itself off to 24, the state was now:

	E	VG	G	A	BA	Marks
TD					🗸	6
TK					🗸	6
LI				🗸		4
B				🗸		4
C					🗸	4

• It isnt as simple as moving a check mark ahead though, when i made it 25, it became 26 with a table of:

	E	VG	G	A	BA	Marks
TD				🗸		12
TK					🗸	6
LI					🗸	2
B					🗸	2
C					🗸	4

• Clearly, it moved LI and B behind, reducing the marks by 4 and it moved TD up by one, increasing the marks by 6, with a net average of 2, just like the other two changes. Anyway, eventually it'll reach a checkpoint at 40 marks where the state it is in, is quite similar to the way it was when it was 20 marks.

	E	VG	G	A	BA	Marks
TD				🗸		12
TK				🗸		12
LI				🗸		4
B				🗸		4
C				🗸		8

• And after this, the exact same pattern follows, where LI is increased, before B, then moved behind while TD is moved ahead.

• This means that if you have 22 marks, or 42 marks, or 62 marks, or 82 marks, you will have the exact same pattern, except its at a different rank.

• Of course this is applicable for every other number, when you add or subtract 20 from it.

• After 40 marks, you cannot have a tick in the BA rank, after 60, you cannot have a tick in the A category, after 80, you cannot have a tick in the G category, and at 100, you cannot have ticks in VG, i.e. you can only have ticks in E.

• We can say that there are exactly 10 patterns. Numbers which have the same value for x%20(where x is the number), will always have the same pattern.

• You can never have an odd number of marks (since each category can only have a multiplicity of even numbers)

According to this, it seems to be viable to use 10 states, take the modulus of the average of the marks to get its state, and to get its rank, simply dividing it by 20(20+ would be BA-A, 40+ would be a G-A category, 60+ would be VG-G, 80+ would be E-VG). Of course, this is a lot more rigid than the current algorithm that already exists, but this is simply a way of representing the algorithm.

Changes Required [BLOG] - #88

Changes required in PR(#88) - @Nidhi-1223

1. Use ## or ### instead of === (MDX version of h1 tag) while giving headings as it should be visible in Table of Contents in your blogs page.

   

2. Use en dash (-) instead of em dash (—) in the Title of the blog

   

Add contributors list

This is a beginner task that anyone outside the organization can attempt. The steps to complete the task are listed below.

• Go through the branches and note down how many members have contributed to the code base.
• Contact @kuxshl to find UI team contributors
• Create CONTRIBUTORS.md in staging branch
• List down all contributors names in alphabetical order (please make sure you create a proper list)
• Push your file to staging

While creating a PR, kindly mention this issue's no (#66) on your PR

Create Custom Navbar Component

Custom Navbar Component

Not as simple as it sounds for docusauras
no configuration is provided by them to create complete custom navbar or footer.
So lets break the rules.

Steps to do so

1. Create custom navbar component
   here basically create a custom component as it is in Figma, make it responsive. No shit you gotta do this full. Don't make dark light mode/theme.
2. Remove Layout in index page under pages and place your navbar above hero section component.

Doing this will only affect the first page, so other pages of our docs and blogs won't be affected.
This is our goal currently.

Create Under Development Projects Section for TCET Open Source Website

->Check Figma for correct fonts and colors
->Make your branch name as issue_number-under-development-projects-section
->Learn about Framer Motion : https://www.framer.com/motion/
->When hovering to the projects animation must happen which can be done using framer motion. Refer this link to see the animation
->It should be responsive

Add Social Card to all Blogs

This is an open issue and anyone internally or externally can contribute to this issue.
We need all blogs in the website to have a social card where one can click and redirect themselves to the blog.

For example;:

Docusaurus themselves are using this approach to showcase all their blogs.

So if anyone wants to contribute to this issue you can mention it down here in the comments section.

Update Readme.md

The readme file serves as the primary source of information about the project, and we believe it can be improved to provide a better understanding of the repository and enhance its overall user experience.

The Readme.md file can contain:

• Improved Project Overview
• Installation and Setup Instructions
• Documentation and Usage Examples
• Contributing Guidelines

[FMC] - Button and Instructions Sections

[TL] - Download Section Component

Create About Section for TCET Open Source Website

->Check Figma for correct fonts and colors
->Make your branch name as issue_number-about-section`
->It should be responsive

Update the About Organization Page

• Teams Section
• Projects Section structure
• Table of Contents

Create Hero Section for TCET Open Source Website

->Check Figma for correct fonts and colors
->Make your branch name as issue_number-hero-section`
->It should be responsive

[FMC] - About Fill My Cycle

[FMC] - Defining Cycle's Section

[TL] - About TCET Linux

create landing page

[UI] Micro Changes

• In developed projects, the right panel, make the active project card brighter
• In underdeveloped projects, left align all text
• Change padding of each component to 1.25rem for mobile i.e p-5 and 4rem for desktop i.e p-16. Except underdevelopment projects, make sure all other components have same padding. In underdevelopment projects, add this padding to only the heading.
• Change the gradient of each component in teams section. Check the new gradient in figma. Copy that.

Add search functionality

Add search bar to the open source website.

The documentation site will consist of several articles and pages for:

• Project installation
• Features
• Blog Posts
• Other articles as the website grows

This feature will be necessary for the documentation site because as the complexity grows, it would be difficult for a novice visitor to be able to browse through the navbars or sidebars to look for a specific feature.

Implement Search Bar

Create a search bar that will allow users to search for docs

Create Teams Section for TCET Open Source Website

->Check Figma for correct fonts and colors
->Make your branch name as issue_number-teams-section
->It should be responsive
->Make use of arrays where required

Create Custom Footer Component

Custom Footer Component

Not as simple as it sounds for docusauras
no configuration is provided by them to create complete custom navbar or footer.
So lets break the rules.

Steps to do so

1. Create custom footer component
   here basically create a custom component as it is in Figma, make it responsive. No shit you gotta do this full. Don't make dark light mode/theme.
2. Remove Layout in index page under pages and place your footer below main tag.

Doing this will only affect the first page, so other pages of our docs and blogs won't be affected.
This is our goal currently.

[FMC] - Footer Section

Document TCET Mumbai Homepage

Components in Homepage

• Header
• About
• Hero
• Magazine Section
• Programmes
• Certified by Action
• Awards and Counters
• Events
• Footer

[TL] - Navbar Component

Document Resume Screener

[TL] - Copy to Clipboard Component

add tnp site low fidelity diagram

[FMC] - Displaying Cycle's Section

Document TCET Linux