Skip to content

techref: Pub tables and Workflows#2

Merged
gabestein merged 7 commits into
mainfrom
techref-06-22-23
Jun 26, 2023
Merged

techref: Pub tables and Workflows#2
gabestein merged 7 commits into
mainfrom
techref-06-22-23

Conversation

@gabestein
Copy link
Copy Markdown
Member

  • Fleshes out pub table decisions
  • Begins discussing workflows

@djagdish @3mcd @kalilsn @howebenhowe @qweliant

@isTravis
Copy link
Copy Markdown
Member

isTravis commented Jun 22, 2023

Perhaps stuffing a bit too much into one PR with this approach, but I think my commits are most helpfully viewed separately (rather than clicking the 'Files Changed' tab on the PR).

  • The first commit updates the Pub, PubType, etc models to reflect what we discussed today.
  • The second commit takes a pass at initial Workflow and Stages models (along with things like claims, moves, and move constraints).

On the former, I opted for more verbose names as we get our bearing. Field -> MetadataField, Metadata -> MetadataValue.

On the latter, there are definitely some naming conventions that need to be worked out, and considerations I'm sure will come up in our next conversation.

Like last time, you can pull this PR down, run npm run reset and you should get an updated database with generated seed content so you can poke around on the Workflows tab:

Screenshot 2023-06-22 at 16-05-02 PubPub v7 Mockup Demo

@isTravis isTravis requested review from 3mcd, howebenhowe, isTravis, kalilsn and qweliant and removed request for 3mcd, howebenhowe, isTravis, kalilsn and qweliant June 22, 2023 20:21
Comment thread TECH_REF.MD
Comment on lines +6 to +7
- Internal side effects: modify Pub metadata, but directly in the app
- External side effects: modify Pub metadata, but via an integration
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wasn't my understanding. My understanding was that integrations can cause either internal or external side-effects (perhaps both), and that those were defined as:

  • Internal side effects: changes pub metadata
  • External side-effects: triggers off-platform events.

The former is internal to our platform (e.g. edits the title, generates a new file, creates a review). The latter is external to our platform (e.g. builds a website, posts to slack, deposits to archival service).

Comment thread TECH_REF.MD Outdated

### Workflows
- Integrations can be connected to any stage.
- Workflow stage actions generally shouldn't change Pub metadata — Pub metadata should be changed in side effects or integrations.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reflecting the above comment, my understanding was that integrations cause side-effects (rather than them being two different ways of modifying metadata).

to reflect some clarifications on 06-26-23.
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

Successfully merging this pull request may close these issues.

4 participants