Setting up the editor

This page is for the family historian who runs gura.name. It explains, step by step, how to turn on the in-browser editor at gura.name/admin/ so that you (and any family members you trust) can sign in with a GitHub account and add or update pages on the site.

You only have to do this once. After it is set up, editing the site is just: visit /admin/, click Login with GitHub, fill in a form, click Publish.

What you need before you start

Step-by-step

  1. Connect Netlify to the repository. Sign in to app.netlify.com. Click Add new site → Import an existing project → Deploy with GitHub. Authorise Netlify to access your GitHub account, then pick the cgura/Gura-Name repository. Netlify will read the build settings from the file netlify.toml that is already in the repository, so you can just click Deploy. Within a minute you should see your site live.
  2. (Optional) Point the gura.name domain at Netlify. In the new site's dashboard, open Domain management → Add custom domain and enter gura.name. Netlify will show you DNS records to add at your domain registrar. Once those propagate, your site is live at gura.name.
  3. Turn on “Sign in with GitHub” for the editor. This is the part that lets the editor at /admin/ use your GitHub account.
    In Netlify's site dashboard: Site configuration → Access & security → OAuth → Install provider → GitHub.
    Netlify will walk you through a short GitHub OAuth-app setup wizard (it asks you to click an Authorise button on github.com). When it finishes, Netlify is acting as the secure go-between so the editor can sign people in with GitHub — no passwords or secret keys are ever stored in this site.
  4. Decide who is allowed to edit. Anyone you want to be able to edit the site needs:
    1. A GitHub account (free), and
    2. Write access to the cgura/Gura-Name repository.
    To grant write access: on GitHub go to github.com/cgura/Gura-Name → Settings → Collaborators → Add people, and invite their GitHub username. They will receive an email and need to accept the invitation.
  5. Test the sign-in. Open gura.name/admin/ in a new browser tab and click Login with GitHub. Sign in with your GitHub account, approve the permission prompt, and you should land on the editor's home screen with a list of People, Stories and Remembrances.
  6. Make a change to confirm everything is wired up. In the editor, open any person, change a small detail (or add a sentence), and click Publish. The editor saves your change back to GitHub as a regular commit under your name. Within about a minute Netlify will rebuild the site and your edit will be live.

How obituaries get reviewed

Each remembrance has an Approved switch in the editor. Only remembrances marked Approved are shown on the public Remembrances page, so you can save an unfinished draft without it appearing on the live site. Flip the Approved switch to on and click Publish when you are ready.

If you get stuck