1
0
mirror of https://codeberg.org/fediverse/fep.git synced 2026-08-06 04:05:53 +00:00
Files
fep/fep-xxxx-template.md
T
a d3cd04d8a8 Migrate to dedicated fep/ directory and FEP-xxxx subdirectories (#109)
as discussed in https://socialhub.activitypub.rocks/t/fep-a4ed-the-fediverse-enhancement-proposal-process/1171/38?u=trwnh onward, and as described in https://socialhub.activitypub.rocks/t/fep-a4ed-the-fediverse-enhancement-proposal-process/1171/57?u=trwnh

Open considerations:

1. This PR copies `feps/fep-xxxx.md` to `fep/xxxx/fep-xxxx.md` for now. There is some consideration for naming it `index.md` instead, in order to ease with potential future static site generation via CI/CD. Imagine a CI/CD task that clones the repo and generates a proper site using `fep` as the content directory. (The idea is that this site may then be served to anyone requesting text/html representations of the `https://w3id.org/fep/xxxx` URI following the specifications laid out in FEP-9606.)

2. This PR does not yet delete any old paths. Everything in `feps/` has been edited to contain a Markdown link to the new location.

Rationale:

- We have encountered FEPs that wish to create their own assets, and the current structure is confusingly laid out. Asset colocation is widely considered a "best practice" for this sort of scenario. Particularly in cases where the rest of the repo's structure may potentially change in the future, asset colocation prevents any FEP-specific links from breaking because those links can be written relative to their FEP root.

- To ease PURL resolution, context documents can be considered sidecar assets to each FEP that defines extension terms. The mechanism for this is again described in FEP-9606. Redirection rules can be simplified to use less conditions, since the base folder remains the same.

Next steps:

- Edit the README.md to update the instructions for submitting a new FEP (pending open consideration 1)
- Set a timeline for when or if the old `feps/` directory should be removed (pending open consideration 2)
- Merge this PR

Co-authored-by: a <a@trwnh.com>
Reviewed-on: https://codeberg.org/fediverse/fep/pulls/109
Co-authored-by: a <trwnh@noreply.codeberg.org>
Co-committed-by: a <trwnh@noreply.codeberg.org>
2023-06-13 20:46:13 +00:00

706 B

slug, authors, status, dateReceived
slug authors status dateReceived
xxxx Alyssa P. Hacker <alyssa.p.hacker@social.example>, Chatty Ben <ben@chatty.example> DRAFT 1970-01-01

FEP-xxxx: Title of your FEP

Summary

References

CC0 1.0 Universal (CC0 1.0) Public Domain Dedication

To the extent possible under law, the authors of this Fediverse Enhancement Proposal have waived all copyright and related or neighboring rights to this work.