Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better team page organisation #5

Closed
ajitzero opened this issue Jan 3, 2020 · 7 comments
Closed

Better team page organisation #5

ajitzero opened this issue Jan 3, 2020 · 7 comments
Assignees
Labels
discussion Requires ideas & debate enhancement New feature or request

Comments

@ajitzero
Copy link
Collaborator

ajitzero commented Jan 3, 2020

Currently, we are managing team pages as team-<YYYY>.html files.

The next logical step is to use static data files to generate the pages instead.

Possible solutions:

  • Use Jekyll to retrieve data from YAML files.
  • Use Angular to retrieve data from JSON files.

In our use case, Angular may be overkill for now since we cannot guarantee that every new web dev team will know Angular, nor can we expect them to learn it due to its steep learning curve. In contrast, Jekyll has a much simpler structure and easier to learn.

If there are other ideas, do put them forward. For now, a complete restructuring for this website with Jekyll seems to be the best way to proceed.

Edit: We are currently simply using HTML/CSS(Sass) with Bootstrap 4.1.1 which means for any future update, we need to deal with HTML tags. Jekyll or Angular use data files to generate the file (in Jekyll's case) or dynamically update the file (in Angular's case).

@ajitzero
Copy link
Collaborator Author

ajitzero commented Jan 3, 2020

@anandabhishek01555 @likhithnemani Let me know your thoughts.

@ajitzero ajitzero self-assigned this Jan 3, 2020
@ajitzero ajitzero added discussion Requires ideas & debate enhancement New feature or request labels Jan 3, 2020
@anandabhishek01555
Copy link
Member

We are not familiar with Jekyll instead . Since you say the code will be simpler in Jekyll , I think we should with that .

@ajitzero
Copy link
Collaborator Author

ajitzero commented Jan 3, 2020

Simpler as compared to Angular.

Jekyll uses plain HTML in all files and allows us to divide components into separate files. That way we can have a file called team.yml which could be:

- 2019
  - Aditya
    - Vice President
    - LinkedIn: URL...
    - key: value...
  - Ajit
    - Treasurer
    - LinkedIn: URL...
    - key: value...
  - ...
- 2018
  - Aditya
    - Vice President
    - LinkedIn: URL...
    - key: value...
  - Ajit
    - Treasurer
    - LinkedIn: URL...
    - key: value...
  - ...
- 2017
  - ...

We can then use this file to loop over the data and generate an HTML file. Later you can simply update the data file & HTML updates automatically. Check out their official website for learning more about how it can help us.

@likhithnemani
Copy link
Member

likhithnemani commented Jan 3, 2020

It slightly looks like JSON file and it is also a good way to update details because we don't need to modify HTML file always instead we can just modify in that page.

@ajitzero ajitzero pinned this issue Jan 3, 2020
@ajitzero
Copy link
Collaborator Author

ajitzero commented Jan 3, 2020

If we can all agree on using Jekyll as the base site generator then we can proceed with potential redesign ideas. We need to highlight our achievements, awards & metrics on our home page.

@likhithnemani
Copy link
Member

likhithnemani commented Jan 3, 2020 via email

@ajitzero
Copy link
Collaborator Author

#10 has been created for the Jekyll update. Closing this thread.

@ajitzero ajitzero unpinned this issue Jan 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Requires ideas & debate enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants