Skip to content

Techref - 2023-06-29#6

Merged
isTravis merged 4 commits into
mainfrom
techref-2023-06-29
Jul 5, 2023
Merged

Techref - 2023-06-29#6
isTravis merged 4 commits into
mainfrom
techref-2023-06-29

Conversation

@isTravis
Copy link
Copy Markdown
Member

@isTravis isTravis commented Jun 29, 2023

Explores the idea of how integrations are "attached". Explores the relationship between pubs, stages, and integrations.

Comment thread TECH_REF.MD
- They can act on 1) specific pubs, 2) all pubs in a given stage(s) over time.
- When creating a new Pub Type, we could provide a "wizard"/helper UI that suggests the fields you'll need based on the integations you want based (e.g. Crossref, Squarespace site builder, Portico deposit).
- We will have a list of all fields that integrations will need declared in the integration's manifest.
- A low-fidelity version is just using that list of fields declared in integration manifests to warn users if they input a field that's not used by any 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.

May not fully understand this bit, but, two thoughts here:

First, sometimes people just want to stuff some metadata somewhere for internal purposes, or that they might user later. We probably shouldn't warn about that.

Second, it seems unlikely that integrations will always have full coverage in a manifest? For example, I can imagine it would make things tough if we expect a generic site builder to need to know to request a birthDate field for an obituary when it can request it after the fact via API. I think, reading this, we're saying that's fine, this is just about the wizard for building new pub types that we may eventually have? But just want to clarify.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yeah, I think this was just about building new pub types and I was suggesting it mostly to avoid typo errors. And perhaps warn was too strong - I just meant the UI should indicate which fields pubpub knows about already and which it doesn't, even if it's not a full wizard that suggests integrations.

Copy link
Copy Markdown
Member

@gabestein gabestein Jun 30, 2023

Choose a reason for hiding this comment

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

Ah right. I remember that. Makes total sense in that context.

@isTravis isTravis merged commit fa60c1f into main Jul 5, 2023
@isTravis isTravis deleted the techref-2023-06-29 branch July 5, 2023 19:18
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.

3 participants