specifications icon indicating copy to clipboard operation
specifications copied to clipboard

Revise How to add markup tutorial

Open AlasdairGray opened this issue 4 years ago • 5 comments

At the community call on 28 June 2021 the following issues were identified with a brief scan of the How to add markup tutorial:

  • It's not long enough (@nsjuty / @AlasdairGray )
  • Missing statement on where the content needs to be added, and what creates that HTML (@egonw )
  • Where to put the JSON-LD in the HTML page? Multiple places in cases of multiple objects (@egonw )

Originally posted by @AlasdairGray in https://github.com/BioSchemas/specifications/issues/488#issuecomment-870733495

AlasdairGray avatar Jun 29 '21 16:06 AlasdairGray

  • [ ] @AlasdairGray to add content from markupathon slides
  • [ ] @ivanmicetic to add experience from IDP use case
  • [ ] @alaninmcr to add experience from ComputationalWorkflow perspective
  • [ ] @albangaignard to add experience from ComputationalTool perspective

The different perspectives may be extracted out into dedicated recipes for those communities.

AlasdairGray avatar Jun 29 '21 16:06 AlasdairGray

There is probably cross-over with the content of the How to select the right profile for your resource

AlasdairGray avatar Jul 01 '21 15:07 AlasdairGray

I think the different perspectives are more for How to select the right profile for your resource than for How to add markup.

Related issues:

  • ComputationalTool https://github.com/BioSchemas/specifications/issues/547
  • Chemical profiles https://github.com/BioSchemas/specifications/issues/554

ljgarcia avatar Nov 04 '21 13:11 ljgarcia

The How to add markup tutorial has been updated and is ready for review, see https://github.com/BioSchemas/bioschemas.github.io/pull/447

ljgarcia avatar Nov 04 '21 13:11 ljgarcia

I think the different perspectives are more for How to select the right profile for your resource than for How to add markup.

Related issues:

I agree, can we move these into a separate issue for that tutorial. Once that is done this issue can be closed.

AlasdairGray avatar Nov 17 '21 15:11 AlasdairGray