Agora Yaml

• If you add an agora.yaml to your [[digital garden]] repository you can use it to configure how the [[agora]] integrates it.
• a [[project]]
  • [[bmann]] suggested adding [[yaml]] support to the [[agora]].
    • [[go]] https://github.com/bmann/bmcgarden/blob/master/agora.yaml
  • [[p0]]
    • It will [[unblock]] many things.
    • It is a valuable [[design contribution]] from [[bmann]].
    • https://github.com/flancian/agora/issues/2
  • there’s several [[aspects]] to this:
    • an agora.yaml in a garden tells any agora how the garden wishes to be integrated, and how its owner wants to use the [[agora]]
    • a gardens.yaml in an agora configures the [[agora]] in question to interact with a set of data sources.
• [[push]] [[agora feature requests]]
  • [[idea]] take [[blog posts]] like https://github.com/bmann/bmcgarden/blob/master/_posts/blog/2011-10-11-turning-the-corner-on-ebook-buying.md and integrate them into the date-stripped node, plus perhaps a link from within the date ([[2011-10-11]] in this example).

• A [[file]].
  • You can put in your garden to configure how Agoras interact with it.
  • … theoretically :) I’ve talked about implementing this for quite long but as of [[2023-01-11]] it hasn’t happened.
  • I want to prioritize this in [[2023]].

Agora.yaml

Agora.yaml will be a standard for [[Agora federation]], intersecting with the [[Mycoverse]]. This is a file, served at .well-known/agora.yaml or available in an Agora-imported repository root. The latter is closer to the modern (may 2023) approach of Agora organisation. The former is supposed to make a totally new approach possible.

The document is a [[YAML]] document, describing:

• The name of the site
• Its URL schemes, including resources contributed to Agora home pages
• Mappings between local resources and canonical rendered views.
• Exclusions and inclusions (like [[robots.txt]])
• Transclusion policy
• Interwiki maps ~ intermaps
• Integration points (where and how to render each local resource in an Agora context, including executable code)

Example document

This one is served

type: <garden|stream|stoa|agora>
name: <Agora of Flancia|Bouncepaw's digital garden>
include: <test>
exclude: <test>
repository_url: <url>
website_url: <url>
interwiki_map: []map
- interwiki:
    name: 
        - mycorrhiza
        - myco
    engine: mycorrhiza
    url: https://mycorrhiza.wiki
    mapping_url: <url>
mapping_type: <slug|literal|static>
mapping_template: https://mycorrhiza.wiki/%s <button class="pull-url auto-pull-button" value="https://mycorrhiza.wiki/%s">pull</button>
slug: <github|agora>
    

Another iteration (simpler):

name: Example site
type: garden
mapping:
-
    names:
        - index
        - home
    type: article
    source_url:
        - https://example.org/index.myco
    rendered_url:
        - https://example.org/index.html
        - https://example.org/home.html

Sanitize [[html]].

Think about [[WebFinger]]? We could statically generate /webfinger, returning essentially the same mapping as above in webfinger format.

An older example contributed by [[bmann]]: #pull https://github.com/bmann/bmcgarden/blob/master/agora.yaml

• a [[feature]].
  • for [[Agora 2023]]
  • See also https://anagora.org/agora-yaml pull