├── .gitignore ├── CNAME ├── Gemfile ├── Gemfile.lock ├── LICENSE ├── README.md ├── _config.yml ├── _layouts └── index.html ├── dev ├── copy-readme-to-index.sh └── post-commit ├── favicon.ico ├── images ├── open-source-protocol-100.png ├── open-source-protocol-200.png └── open-source-protocol.png ├── index.md ├── javascripts └── scale.fix.js ├── params.json └── stylesheets ├── pygment_trac.css └── styles.css /.gitignore: -------------------------------------------------------------------------------- 1 | _site 2 | _site 3 | -------------------------------------------------------------------------------- /CNAME: -------------------------------------------------------------------------------- 1 | osprotocol.com 2 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | gem 'jekyll' 3 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | GEM 2 | remote: https://rubygems.org/ 3 | specs: 4 | addressable (2.5.0) 5 | public_suffix (~> 2.0, >= 2.0.2) 6 | colorator (1.1.0) 7 | ffi (1.9.14) 8 | forwardable-extended (2.6.0) 9 | jekyll (3.3.1) 10 | addressable (~> 2.4) 11 | colorator (~> 1.0) 12 | jekyll-sass-converter (~> 1.0) 13 | jekyll-watch (~> 1.1) 14 | kramdown (~> 1.3) 15 | liquid (~> 3.0) 16 | mercenary (~> 0.3.3) 17 | pathutil (~> 0.9) 18 | rouge (~> 1.7) 19 | safe_yaml (~> 1.0) 20 | jekyll-sass-converter (1.5.0) 21 | sass (~> 3.4) 22 | jekyll-watch (1.5.0) 23 | listen (~> 3.0, < 3.1) 24 | kramdown (1.13.1) 25 | liquid (3.0.6) 26 | listen (3.0.8) 27 | rb-fsevent (~> 0.9, >= 0.9.4) 28 | rb-inotify (~> 0.9, >= 0.9.7) 29 | mercenary (0.3.6) 30 | pathutil (0.14.0) 31 | forwardable-extended (~> 2.6) 32 | public_suffix (2.0.4) 33 | rb-fsevent (0.9.8) 34 | rb-inotify (0.9.7) 35 | ffi (>= 0.5.0) 36 | rouge (1.11.1) 37 | safe_yaml (1.0.4) 38 | sass (3.4.22) 39 | 40 | PLATFORMS 41 | ruby 42 | 43 | DEPENDENCIES 44 | jekyll 45 | 46 | BUNDLED WITH 47 | 1.13.6 48 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015 Richard Littauer 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Open Source Protocol 2 | 3 | ### About 4 | 5 | The Open Source Protocol is a way of telling developers where to access the source code for your website, if the source code is hosted in an open source repository on the public internet. 6 | 7 | The OS Protocol uses metatags. To include an open source metatag on your website, simply add `` tags for the following properties: 8 | 9 | * `os:repo` - This should be a link to the repository web page, for instance the project page on GitHub, Bitbucket, or Sourceforge. 10 | * `os:rcs_type` - This should be the name of the revision control system used, for instance Git, Mercurial, Bazaar. 11 | * `os:src` - This is the repository url that can be used to obtain a copy of the source. 12 | 13 | This is not a place to link to code that is described on your website; rather, this is for the code _for the actual website_. That way, if anyone reading your website sees an error - a spelling mistake, broken CSS, etc. - or something they want to examine - a cool paralax library, etc. - they can quickly fetch the source code. 14 | 15 | The `os` protocol is loosely based on the [Open Graph protocol](http://ogp.me/), which in turn is based on [RDFa](https://en.wikipedia.org/wiki/RDFa). `os` stands for "open source". 16 | 17 | A `link` element must be added in order to adhere to the standard. This is similar to the now deprecated `profile` attribute, which used to go into the `
46 |This project is maintained by RichardLitt.
57 |`. 18 | 19 | ### Example 20 | 21 | ```html 22 | 23 | 24 | 25 | 26 | ``` 27 | 28 | ### Optional tags 29 | 30 | Other tags that can be used: 31 | 32 | * `os:issue` - This links to a place to report issues for the website. 33 | * `os:commit` - This is the commit id that the current site is based upon, as that may not always be the same as HEAD. 34 | * `os:branch` - This is the branch where the live code for the website lives. 35 | * `os:server:*` - If there's separate custom code for a server (for example, a server written using [node.js](https://nodejs.org)), and the code for which doesn't include the website content source as a submodule or mention it in some other way, then the tags `os:server:*` can be used to separately specify the server code. Here \* denotes all the other `os:*` tag subtypes specified in this document. 36 | 37 | #### Examples 38 | 39 | ```html 40 | 41 | 42 | 43 | ``` 44 | 45 | ### Shields 46 | 47 | For use in the repository, to show your compliance and spread the word: 48 | 49 |  [https://img.shields.io/badge/OSMT-passing-green.svg](https://img.shields.io/badge/OSMT-passing-green.svg) 50 |  [https://img.shields.io/badge/OSMT-failing-red.svg](https://img.shields.io/badge/OSMT-failing-red.svg) 51 | 52 | ### Participating Websites 53 | 54 | This is a list of websites which have adopted this protocol. If you know of any others, please add them here. 55 | 56 | * [angular-meteor.com](http://angular-meteor.com/) 57 | * [burntfen.com](http://burntfen.com) 58 | * [theuserismymom.com](http://theuserismymom.com) 59 | 60 | ### Related Projects 61 | 62 | Projects building on OSP: 63 | 64 | * [OSMT-extension](https://github.com/RichardLitt/osmt-extension) Chrome extension to check for OSMT compliance. _WIP_. 65 | 66 | ### Contribute 67 | 68 | This is a work in progress. Please open an [issue](https://github.com/RichardLitt/open-source-protocol/issues) to discuss how the Open Source Protocol can be improved. PRs are encouraged! 69 | 70 | If you use the OSProtocol, please add your site above. Also, tell your friends. 71 | 72 | To automatically copy `README.md` from `master` to `gh-pages`, use the hook on `gh-pages` in `dev`. (_Note: It doesn't like `git add -p`_). 73 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | markdown: kramdown 2 | path: https://osprotocol.com 3 | -------------------------------------------------------------------------------- /_layouts/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
4 | 5 | 6 |
7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 44 | 45 |