Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs are incomplete when using Netlify for auth but not hosting (using Github Backend) #66

Open
daniel-keller opened this issue Jun 7, 2024 · 1 comment

Comments

@daniel-keller
Copy link

daniel-keller commented Jun 7, 2024

Decap CMS docs provide instructions for setting up the Github backend and explains why a netlify site, even if unused for hosting, is necessary for authentication. When providing instructions for this setup the docs direct devs to the Netlify docs (paragraph 3, step 1.). The Netlify docs assume Netlify is the hosting service and so a crucial step is not provided to devs who want to host their site on Github Pages (and I assume other services but I haven't confirmed this) but use Netlify for auth services.

The missing steps are as follows:

  1. Change the CMS site_domain configuration to the domain of the Netlify dummy site
  2. Register your Github Pages' site domain name within Netlify's "Domain Management" settings.

Without these steps your login into Decap on your Github Pages site will result in a "Not Found" message.

Sources are the Netlify Discord and this blog post

Could you update the docs to include these steps?

@daniel-keller daniel-keller changed the title Docs are incomplete when using Netlify for auth but not hosting with github backend Docs are incomplete when using Netlify for auth but not hosting (using Github Backend) Jun 7, 2024
@martinjagodic martinjagodic transferred this issue from decaporg/decap-cms Jun 10, 2024
@martinjagodic
Copy link
Member

@daniel-keller are you willing to contribute the missing steps as a PR? It would be much appreciated 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants