astropy / learn-astropy-librarian

The content crawler that supplies Learn Astropy's web search.
BSD 3-Clause "New" or "Revised" License
1 stars 5 forks source link

Alternate metadata format for tutorials to support third-party sites #20

Open jonathansick opened 2 years ago

jonathansick commented 2 years ago

The current metadata standard for tutorials involves a specific format in the notebook content. Keywords, authorships, and descriptions are extracted heuristically from the content. For third-party tutorial sites, we can't impose this specific format. Instead, we should have a way for authors to define Learn Astropy metadata without affecting their notebook's content. Besides the schema for this metadata, the main question is the format (notebook metadata? YAML sidecar file that's hosted on the website?).