search

ThePacielloGroup / cupper

An inclusive pattern library builder.
MIT License
348 stars 358 forks source link

Add “Edit this page” functionality (see Hugo Learn Theme for reference) #25

Open aral opened 6 years ago

aral commented 6 years ago

The Hugo Learn Theme has an “edit this page“ feature. This would be a valuable addition to Cupper and should be relatively easy to port from that theme.

Reference: https://learn.netlify.com/en/ Source: https://github.com/matcornic/hugo-theme-learn

frastlin commented 5 years ago

I'm searching for a way our non-technical staff can write documentation using Cupper and this may solve one of the more difficult problems of needing users to download git and npm, clone the repo, make their changes in a .md file, commit the changes, and push to the main repo. This would reduce that step to clicking edit on the page, editing the file and clicking submit.

It would be even nicer if there was a rich text editor that users could write their changes in, click submit, and have a script convert the rich-text to markdown, and submit a pull request. But this would be good for now. The use of Github is a very high learning curve for most people and to be inclusive to them, it would really help to reduce the editing and file creation as much as possible.

Heydon commented 5 years ago

@frastlin Hi Brandon. This would represent a huge investment in terms of converting Cupper into a fully fledged GUI/CMS. Your best bet is probably to use Hugo/Cupper with a headless CMS like https://www.datocms.com/cms/hugo/

frastlin commented 5 years ago

Wow, I have never heard of a headless CMS, thank you for sharing! They are quite expensive though, especially if one wants to use a new version of Cupper for each company manual. I'm seeing $19-150 a month per project... There are a few like Strapi that seem to be free and opensource. Now the question is: What headless CMS is most accessible? I googled it and only found one talk on the topic that is mostly pointing out the problems of programming dynamic content without knowledge of HTML. Headless CMS accessibility was not mentioned at all. It may be useful to write a brief guide on how to integrate Cupper with a headless CMS, as there may be other people who want this functionality, but don't know how to get it. Alternatively, there is Prose that is meant to be a simple content editor for projects hosted on Github. So there are two use cases that are being mentioned here:

  1. Allow anyone to offer edits as a PR to a Cupper site through an edit page link.
  2. Allow nontechnical users to edit the site without needing to know Github or Markdown.

They relate, but are not exactly the same. I created #41 to further discuss this issue.