Portal EPIC: Move Gitbooks into a different Content Management System

makerdao / community

Contains current and historical governance polls and executives used in the governance of the Maker Protocol. Previously contained a lot of other content which remains in the 'prior-cleanup' branch.

https://forum.makerdao.com/

GNU Affero General Public License v3.0

192 stars 161 forks source link

Portal EPIC: Move Gitbooks into a different Content Management System #225

Closed ghettodev closed 3 years ago

ghettodev commented 5 years ago

There are some limitations to the gitbooks implementation that we can’t get around. Community Development would like someone to create a new framework for us with docusaurus that basically looks and behaves exactly like the existing portal.

Working Doc

Criteria:

searching with algolia or equiv
easily maintained css
should sit in the same repo as the existing content?
or can we set up a new repo that ingests content from the primary repo?

https://forum.makerdao.com/t/wanted-a-docusaurus-setup-to-replace-the-existing-portal/149

scottrepreneur commented 5 years ago

I started this here with some outstanding questions. https://github.com/scottrepreneur/maker-community#questions

amy-jung commented 5 years ago

@scottrepreneur : adding original problem with Gitbooks:

Every link in the body of the text needs to exist in the left nav or it is replaced with a github link
Inability to embed arbitrary code (limits our ability to include transparency dashboard)
Limited theming options
No LaTex, it converts everything to json in its side and messes with formatting

amy-jung commented 5 years ago

Migration script blockers answered here: https://hackmd.io/Td-PoJUBTi61cs3PHKDKYw?both

scottrepreneur commented 5 years ago

Updates needed to smoothen integration with new portal https://github.com/makerdao/community/pull/296

amy-jung commented 5 years ago

Tasks:

[x] Scaffold
[ In progress ] Update community repo and transform script
[ ] Community repo: add headers to all files, move README to top level files update links to those top level files
[ ] Transform: API ping?, clone into new repo into ‘docs’ directory, remove unneeded headers
[x] Implement search - algolia plugin - update API Key once live and crawled
[x] Sidebar for meeting summaries and transcripts is separated because submenus are not collapsable in v1
[ ] Implement translations with CrowdIn
[x] Implement config adjustment to remove ‘docs’ from URL
[x] **Implement Edit on Github
[ ] Design and implement ‘Landing’ page
[x] Check for broken links
[ ] Design Finishing
[ ] Plan for migrating into Docusarus 2
[ ] Maintenance plan

amy-jung commented 4 years ago

This initiative is put on hold until the end of the year.

scottrepreneur commented 4 years ago

The first iteration of Docusaurus v1 is done. https://github.com/scottrepreneur/maker-community

twblack88 commented 3 years ago

New Gatsby powered CMS migrated on 10-6.