teach-la-website icon indicating copy to clipboard operation
teach-la-website copied to clipboard

Updated & Restructured Dev Docs, Updated Footer and Sidebar

Open matthewcn56 opened this issue 4 years ago • 7 comments

Our projects like the Editor and the Learning Labs will need either npm or yarn for package management, so this adds in the info needed to install them inside of dev-setup.md

matthewcn56 avatar May 27 '21 16:05 matthewcn56

My two cents as a retiree - might be better to make this two separate pages, i.e.

  • setting up your environment for the website
  • setting up your environment for editor/learning labs

Ngl the docs are a bit of a mess, so feel free to revamp them!

mattxwang avatar May 27 '21 20:05 mattxwang

My two cents as a retiree - might be better to make this two separate pages

Sounds good! With a bit of a reorganization now...

  • dev-setup.md is the base page for set-up, and links to and from the project-setup page as well.
  • Changed Add To Team Page to Website Setup and added in Project Setup to both the footer and sidebar.
  • Changed the index.html of _docs to support both website and project setup.
  • Added vendor directory in to .gitignore since ruby default adds in vendor when you run bundle sometimes.

matthewcn56 avatar Jun 15 '21 05:06 matthewcn56

Thanks for the feedback @mattxwang! I think that we can take out dev-setup.md and just discuss the Git stuff inside of _doc's index.html and making that be the default dev-setup page, and separating all the ruby, Jekyll etc stuff onto the website setup page would help differentiate between project vs. website set-up better! I def agree that rn it's a bit confusing of where everything is

matthewcn56 avatar Jun 15 '21 05:06 matthewcn56

Restructured the pages more by combining static website set-up and first steps, moving all the git stuff into dev-setup, changed what Dev Setup in the footer linked to, updated pages to include the Dev Resources Page

matthewcn56 avatar Jun 22 '21 17:06 matthewcn56

@matthewcn56 any way i can help?

reginawang3495 avatar Jul 13 '21 19:07 reginawang3495

So sorry about that, will finish this up this weekend! Just have to move around a couple files

matthewcn56 avatar Jul 13 '21 20:07 matthewcn56

Oh no worries! didnt know if you were waiting on vivian and i could help or something :))

reginawang3495 avatar Jul 13 '21 20:07 reginawang3495