Skip to content

Create "Content Workflow" page for Beamable Unity SDK that teaches Content Snapshots usage #145

Description

@allister-beamable

As a game developer focusing on game content,
In order to quickly and clearly collaborate with teammates regarding content,
I want a trustworthy Git-based workflow for tracking our content work.

Beamable content's "source of truth" may have different facets depending on whose workflows are interacting with it. From the perspective of game clients and Beamable backend systems, the body of content that is published to a realm is THE source of truth for that realm's content. However, for developers working on content itself and the gameplay behavior attached to content, there is an in-between truth that boils down to "this is my working copy of content; I may publish it soon, but before I do I might make changes, and furthermore I might need to share it with colleagues prior to publishing". Supporting the latter workflow wants something that can be committed to Git (or other source control).

The Beamable Unity SDK already has a Git-friendly way of capturing content: Content Snapshots. The gap we must bridge is that, until now, we have not adequately taught developers how to use snapshots effectively and work them into their Git-based workflows.

Create a new page in the help.beamable.com docs for the Beamable Unity SDK named "Content Workflow", describing how to use snapshots in conjunction with Git, as well as describing what snapshots are in general and the different ways you can use them. Be sure to cover workflows for a team who wants to be pushing and pulling Git frequently during the day, and workflows for individuals or extremely small teams who might value a single source of truth more than the collaborative convenience that snapshots-in-Git afford.

Existing pages to consider while writing the new one:

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions