Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First draft of a BCO to markdown schema #327

Open
kee007ney opened this issue Jun 4, 2024 · 5 comments
Open

First draft of a BCO to markdown schema #327

kee007ney opened this issue Jun 4, 2024 · 5 comments
Assignees

Comments

@kee007ney
Copy link
Collaborator

kee007ney commented Jun 4, 2024

Write a first draft of a schema for exporting a BCO to markdown (use the GitHub flavor of markdown).
E.g. "object_id" and "name" (from Provenance Domain) can be H1, top level domains can be H2, steps can be a numbered list, etc.

My Example BCO

BCO_123456

Usability Domain

This is a spectacular pipeline for doing cool things.

Provenance Domain

Field Value
Version 1.0
License https://opensource.org/license/mit
Created 2020-10-24T17:14:10.212Z

Description Domain

Steps

  1. Download the data
  2. Preprocess it
@kee007ney
Copy link
Collaborator Author

kee007ney commented Jun 4, 2024

Assign to Aditya.

@kee007ney
Copy link
Collaborator Author

Maybe change ISO8601 formatting to something more readable (like 24 October, 2020).

@kee007ney
Copy link
Collaborator Author

@kee007ney
Copy link
Collaborator Author

Product will take the form of:

  • A schema (formatted as a table, BCO field name on the left, markdown equivalent on the right)
  • The example BCO from above written according to your schema

@kee007ney
Copy link
Collaborator Author

kee007ney commented Jun 12, 2024

@NiramishCuisine please merge your schema table and example file into this repo when ready for us to review.

(If you have not already, please create a new repository in this organization and dump your code into it. You can call it bco2markdown.)

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

No branches or pull requests

2 participants