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

[Hugo Migration] Render each group as a "course" with proper semesters #34

Closed
2 of 4 tasks
jmuchovej opened this issue Dec 17, 2019 · 1 comment
Closed
2 of 4 tasks
Assignees
Labels
🖥️ tool:hugo The static site generator we use. https://gohugo.io/ 🎆 feature-request 🔑 required Tasks that **need** to be completed, ASAP. 💊 discussion 🚀 done ship it!

Comments

@jmuchovej
Copy link
Member

jmuchovej commented Dec 17, 2019

Just a note, when referring to groups... groups := {intelligence, core, data-science, supplementary}

Feature Request, for ucfai/ucfai.github.io (club website)

Description The current edition of the website uses Jekyll as the static site generator. Generally, given how finicky Ruby/Jekyll has been, in the past, coupled with the speed of Hugo – it makes sense to transition to Hugo. There's also a bomb template, call hugo-academic that integrates a tonne of intended feature additions to our current website.

These include things like:

  • Individual author pages (for each Coordinator/Maintainer)
  • Better meeting association with each Lecturer
  • Built-in Course/Documentation "framework"

Needs

  • Test output of dropping previously rendered meeting page (try CNNs or RNNs) into hugo-academic
  • Use this as feedback to modify the export_notebook_as_post function in autobot to proper render and path the markdown render. (Note this in the comments, once we know this, [Hugo Migration] Metadata generation and directory restructuring #35 will cover the actual development.)
  • Check that we can sort by semester
  • <group>/<semester>/_index.md should list all the <group>'s Coordinators for that <semester>

Initial Comments

  • Recommendation: Start from scratch with a fresh-setup of hugo-academic and play with it's directory structure / inject pages. Don't try making a full migration from the Jekyll site to Hugo. autobot can do this!
  • hugo-academic's documentation on courses
    • What happens if we use multiple versions of this?
      (e.g. rather than having courses laid out like in the documentation, we instead do...)
content
├── docs  # follow the hugo-academic docs layouts
├── core
|   ├── _index.md
|   ├── fa18
|   |   └── _index.md
|   ├── ...
|   ├── sp18
|   |   └── _index.md
|   └── ...
├── intelligence
|   └── ...
└── supplementary
    └── ...

Once this has completed, the following tasks will be migrated to ucfai/ucfai.github.io:

  • (🔑 Required) Combine the content buttons from hugo-academic's paper/project pages
  • (🔑 Required) Ensure that hugo-academic's "authors" properly link to the "course" pages.
  • (🍜 Nice to Have) Setup "Documentation" structure for...
@jmuchovej jmuchovej added 📝 todo Items in still in ideation, discovery, or planning "mode." 🔑 required Tasks that **need** to be completed, ASAP. labels Dec 17, 2019
@jmuchovej jmuchovej added this to the Winter 2019 Upgrade milestone Dec 17, 2019
@jmuchovej jmuchovej added the 🖥️ tool:hugo The static site generator we use. https://gohugo.io/ label Dec 17, 2019
@jmuchovej jmuchovej changed the title [Hugo Migration] Migrate the pages/layouts for core, intelligence, data-science, and supplementary [Hugo Migration] Render each group as a "course" with proper semesters Dec 17, 2019
@jmuchovej jmuchovej added the 🚧 in progress Moved from TODO-like state to actual development label Jan 8, 2020
@jmuchovej
Copy link
Member Author

Migrating to ucfai/ucfai.github.io.

@jmuchovej jmuchovej added 🚀 done ship it! and removed 🚧 in progress Moved from TODO-like state to actual development 📝 todo Items in still in ideation, discovery, or planning "mode." labels Jan 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🖥️ tool:hugo The static site generator we use. https://gohugo.io/ 🎆 feature-request 🔑 required Tasks that **need** to be completed, ASAP. 💊 discussion 🚀 done ship it!
Projects
None yet
Development

No branches or pull requests

5 participants