#18 URLs and names in examples

Open
opened 1 year ago by fr33domlover · 0 comments

I looked at some examples in the spec draft and I noticed that some properties whose values are/should be URLs have things like:

  • localhost: Technically a valid host part for an HTTPS URI, but it's not really relevant to the fediverse; websites on the fediverse need to be world-accessible with a stable hostname
  • "" (empty string): This is invalid because the empty string isn't a valid absolute URI. Sadly (but honestly I'm not surprised at all) JSON-LD 1.0 doesn't require URIs to be valid, and some software may just happen to be ok with empty strings there, but "" isn't an absolute HTTPS URI and therefore invalid.

I'd like to suggest that in the examples in the spec we use some made-up example hostnames much like in the ActivityPub spec, except that we'd choose names related to forges. For example, in the Vervis federation docs, I use names like:

  • example.dev
  • federated.dev
  • dev.social
  • dev.community

@zPlus, @bill-auger, @vaeringjar, what do you think? :)

A related question is about names. The AP spec has some creative non-normative descriptions, and those descriptions include using person names that aren't just Alice and Bob. I'm doing the same in Vervis (honestly, because I just enjoy putting in some creativity, it's harder for me to follow strict Alice-and-Bob formality), and I'd love to do this here in the ForgeFed spec. How do you feel about that?

(If you're unsure, that's fine, I can make one such example and then you can see how you feel about it)

(Btw the Vervis federation document is here)

I looked at some examples in the spec draft and I noticed that some properties whose values are/should be URLs have things like: - `localhost`: Technically a valid host part for an HTTPS URI, but it's not really relevant to the fediverse; websites on the fediverse need to be world-accessible with a stable hostname - `""` (empty string): This is invalid because the empty string isn't a valid absolute URI. Sadly (but honestly I'm not surprised at all) JSON-LD 1.0 doesn't require URIs to be valid, and some software may just happen to be ok with empty strings there, but `""` isn't an absolute HTTPS URI and therefore invalid. I'd like to suggest that in the examples in the spec we use some made-up example hostnames much like in the ActivityPub spec, except that we'd choose names related to forges. For example, in the Vervis federation docs, I use names like: - example.dev - federated.dev - dev.social - dev.community @zPlus, @bill-auger, @vaeringjar, what do you think? :) A related question is about names. The AP spec has some creative non-normative descriptions, and those descriptions include using person names that aren't just Alice and Bob. I'm doing the same in Vervis (honestly, because I just enjoy putting in some creativity, it's harder for me to follow strict Alice-and-Bob formality), and I'd love to do this here in the ForgeFed spec. How do you feel about that? (If you're unsure, that's fine, I can make one such example and then you can see how you feel about it) (Btw the Vervis federation document is [here](https://dev.angeley.es/s/fr33domlover/r/vervis/s/FEDERATION.md#spec))
Sign in to join this conversation.
Loading...
Cancel
Save
There is no content yet.