Decap CMS: Git editing and site publication
Assess Decap CMS and the former Netlify CMS name. Check repository editing, authentication, preview and the build that publishes store content.
- Published
- Last updated
Decap CMS gives editors a browser interface for changing content stored in Git. Your site’s build and hosting service turn those saved files into public pages. It suits retail teams whose buying guides and policies already live in a repository, provided a developer owns authentication and publication.
Identify Decap and the Netlify CMS name
Decap CMS is the current name of the open-source project formerly called Netlify CMS. The project changed its name in 2023. An older tutorial or configuration using the Netlify CMS name can therefore describe the same project’s earlier setup.
Netlify is a separate platform for building and hosting websites. Decap can work with another hosting provider and your own build process. The editor changes source files. The public store remains the responsibility of the system that builds and serves those files.
When assessing an existing installation, identify its installed Decap version and backend before following an older tutorial. Compare its authentication configuration with the current instructions for that backend. A familiar product name alone doesn’t establish that the old login setup still fits.
Configure content collections for editors
Decap’s collections map editor fields to the files your site reads. Folder collections suit repeatable buying guides, while file collections suit specific records such as a delivery policy. The configuration reference documents both approaches and the supported formats, including Markdown with front matter, YAML, TOML and JSON.
For a hypothetical retailer, a buying guide could have a title, body, category identifier and image. A policy record could have a fixed file location and a body field. Match those fields to the existing site’s parser. An attractive editing form is useful only if its saved output still builds correctly.
Configure the media storage folder and public image path together. Save an image, inspect its resulting reference and confirm that the built page loads it. Keep required alt text in the content model your frontend actually renders.
Decide whether editors can publish directly. By default, saving commits to the configured publication branch. The documented editorial workflow adds draft branches and review before publication on supported backends. Review controls in the editor must agree with the repository’s permissions and branch rules.
Follow an edit through the publishing build
A Decap edit reaches shoppers only after the configured publication process succeeds. Use one policy change to assess the whole route, including any separate copy used for automated answers.
- Sign in as an ordinary editor through the chosen backend. Confirm that the editor can open the intended collection and save a harmless change.
- Inspect the saved repository change. With editorial workflow, the draft has its own branch and review request. Confirm that the change affects the expected content file.
- Open the built preview. Decap’s deploy preview links depend on a build service that builds unpublished changes and reports their status to the repository. Match the collection’s preview path to the rendered page.
- Approve the change through the configured review process. Publishing merges the editorial change into the publication branch. The production build must then succeed and its output must reach the host.
- Open the public policy page and read the changed passage. If another system imports that policy for answers, confirm that its refresh has completed and that it uses the approved text.
For example, a retailer might change the instructions for returning a bulky item. A correct editor preview proves the draft renders. It doesn’t prove that the public returns page or a separately imported policy has changed.
If the repository has the new text but the public page has the old text, inspect the build’s source branch and result first. Then check deployment and caching. If only the answer source is stale, inspect its import trigger and last successful refresh.
Own the repository and operating work
Decap needs an owner for repository access and an owner for the build that publishes its content. Its backend documentation covers several Git services and Git Gateway. Workflow support differs by backend, so choose the backend against the review process you need.
For the direct GitHub backend, editors sign in with a GitHub account and need push access to the content repository. The GitHub setup instructions also require server-side authentication. Netlify can provide that authentication, or you can configure an external authentication server. Hosting the finished store elsewhere remains possible.
Record who maintains that authentication service, who can revoke an editor and which service account can deploy the site. Keep deployment credentials in the build service’s protected configuration. Editor access to content doesn’t require exposing those credentials in editable files.
Recovery must include the content history, media and enough configuration to rebuild the site. A repository copy won’t recover externally stored images by itself. Rehearse restoring a previous policy version through the same build path and confirm that dependent answer sources refresh too.
Choose Decap when editing files through reviewed Git changes fits your team. Before handing it to editors, prove that one approved change reaches the public page and that one recovery reaches it again.
Give your store its own shopping agent
Customers ask in their own words. Your agent finds, compares and checks out from your catalogue, right on your site.