superfaceai / spec

The Comlink Specification. Comlink is a new interface description and integration language build self-integrating applications.
https://superface.ai/docs/comlink/specification
MIT License
11 stars 1 forks source link

Chore: Allow for multiple versions of specifications #15

Closed zdne closed 3 years ago

zdne commented 3 years ago

This PR introduces multiple versions of specification using the directory structure. The current working revision should be in the spec/draft folder while previous release are in their respective spec/MM.DD.YYYY folders.

Build process was updated accordingly using the foreach cli.

Note, currently both version draft and 02.19.2021 are identical.

The research files, previously stored in this repository are now kept for reference here: https://github.com/superfaceai/spec-research

vercel[bot] commented 3 years ago

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/superface/specification/vmwmfFBhQbnjJ2kXbWuqN7zww6Ev
✅ Preview: https://specification-git-chore-mutliple-versions-superface.vercel.app

zdne commented 3 years ago

I think we should change the text in the the 02.19.2021 specs to not say current working draft but the date for the release.

Added.

One thing to note: the format MM.DD.YYYY will mean you can't order the specs by their release dates (e.g. 01.01.2030 would come before 02.19.2021). It would be possible with YYYY.MM.DD. However, I don't think you have to change this. I just wanted to point it out.

Good catch! Changed to YYYY.MM.DD.