HugoBlox/hugo-blox-builder

Update documentation https://docs.hugoblox.com/getting-started/cms/decap/

alanlivio opened this issue · 3 comments

alanlivio commented

Prerequisites

  • I have searched for duplicate or closed feature requests
  • I am mindful of the project scope

Proposal

I found it difficult to use the Hugo Blox with the DecapCMS local backend (i.e. local git) and not use netlify.
See my problem details here.
The documentation on https://docs.hugoblox.com/getting-started/cms/decap/ helped me. It has a commented line for local_backend: true but does not precisely say how to use the DecapCMS local backend.
It was this DecapCMS guide that helped after run npx decap-server on the root directory.

My feature request is to update the documentation https://docs.hugoblox.com/getting-started/cms/decap/ with this information.

Motivation and context

Lacks of information in the documentation

alanlivio commented

Hi @gcushen. I will be more precise in my feature request.
On page https://docs.hugoblox.com/getting-started/cms/decap/, I propose the change

Configure
You can customize the CMS with a few options in params.yaml.

  • branch: if your Git branch is not main, set it here
  • local_backend: edit local files rather than remote GitHub files
  • publish_mode: set to "editorial_workflow" for a team-based review system

To

Configure
You can customize the CMS with a few options in params.yaml.

gcushen commented

Thanks for being more specific on what improvements you were suggesting. The site has now been updated. Feel free to suggest any further improvements to the docs in another issue or on Discord #contributing channel :)