Skip to content

Commit

Permalink
Update README to reflect manually triggering a redeploy after updatin…
Browse files Browse the repository at this point in the history
…g a Blog Post via Contentful CMS
  • Loading branch information
adamjarling committed Nov 21, 2023
1 parent 4b7bf4d commit 4886974
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,32 @@ How do I use this app / code repository / website?

## Content managers

If you are adding or updating content on the Samvera.org website, you'll update files in this project's `/markdown` folder, or at [Contentful CMS](https://www.contentful.com/).
Adding or updating content to the Samvera.org website happens in one of two ways:

1. At [Contentful CMS](https://www.contentful.com/)
2. Update local project files in the `/markdown` folder

### Contentful CMS

The preferred method of updating site content is through the [Contentful](https://www.contentful.com/) headless CMS (Content Management System). This is a web-based interface that allows you to edit content in a more user-friendly way than editing markdown files. The CMS is currently used to provide data for the following pages/info on the site:

- Blog posts (https://samvera.org/news-and-events)
- Samvera Partners (https://samvera.org/)
- Examples and Demos (https://samvera.org/repository-solutions/examples-and-demos)
- User Profiles (https://samvera.org/the-community/user-profiles)
- Service Providers (https://samvera.org/the-community/service-providers)
- FAQ (https://samvera.org/the-community/faq)
- Samvera Adopters (https://samvera.org/the-community/samvera-adopters)

#### Blog Post updates

Blog Posts (ie. News and Events) updated via Contentful are used to create dynamic individual pages at build time, since samvera.org is a static site (no server interaction). After creating or updating Blog Post content, you must manually trigger a re-deploy of the samvera.org site.

1. Go to the Github Actions tab in the `samvera.org` repository.
2. Click on "Deploy to GitHub Pages" in the left-hand column, under "Actions" / "All workflows".
3. Click on "Run workflow" in the upper right-hand corner (see screenshot below):

![image](https://github.com/samvera/samvera.org/assets/3020266/056d1558-216c-4bdd-aa43-adda71a9e6ac)

### Markdown

Expand Down Expand Up @@ -43,18 +68,6 @@ Adjust these to taste.

(For now), site updates will follow a [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). Best practice is to create a new branch (from the `main` branch), make your edits, and create a PR (Pull request). Assign a member of the Samvera Community to review your PR. Once approved, merge your branch back into `main`. All commits to the `main` branch (our production branch), will trigger a new build of the website. Github Actions will also automatically deploy a public version of the website to: https://samvera-labs.github.io/samvera.org/.

### Contentful CMS

The second method of updating site content is through the [Contentful](https://www.contentful.com/) headless CMS (Content Management System). This is a web-based interface that allows you to edit content in a more user-friendly way than editing markdown files. The CMS is currently used to provide data for the following pages/info on the site:

- Blog posts (https://samvera.org/news-and-events)
- Samvera Partners (https://samvera.org/)
- Examples and Demos (https://samvera.org/repository-solutions/examples-and-demos)
- User Profiles (https://samvera.org/the-community/user-profiles)
- Service Providers (https://samvera.org/the-community/service-providers)
- FAQ (https://samvera.org/the-community/faq)
- Samvera Adopters (https://samvera.org/the-community/samvera-adopters)

### Non-markdown driven pages

_Note this content is currently in transition to Contentful CMS._
Expand Down

0 comments on commit 4886974

Please sign in to comment.