diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..e3488061 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,4 @@ +{ + "projectName": "ngff", + "projectOwner": "ome" +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c28075ab..86dbd094 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,4 +10,17 @@ https://docs.openmicroscopy.org/contributing/ branch or `develop` * Make your commits and open a PR - \ No newline at end of file +# Contributing to this repository + +## Syntax +This repository uses Sphinx to publish a ReadTheDocs site at https://ngff.openmicroscopy.org in the [Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/en/stable/). + +[MyST](https://myst-parser.readthedocs.io/en/latest/) syntax can be used in addition to basic Markdown and HTML. + +## Configuration +Edit [conf.py](./conf.py) with options from the [Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/en/stable/). The [PyData Sphinx Theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide) user guide may also have more up to date instructions for configuration properties. + +## Previews +Each PR receives a unique preview URL of the format `https://ngff--.org.readthedocs.build/` where `` is the PR number. This link is also posted to each PR by the Github actions bot in an "Automated Review URLs" comment as the "Readthedocs" link. + +Please check that your changes render correctly at this URL. New commits will automatically be live at the PR url after a few minutes. \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md index 911bbfb1..9634cd39 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,8 +1,15 @@ -All Reports in this Repository are licensed by Contributors under the [W3C Software and Document -License](https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document). +Copyright (C) 2005 - 2016 Open Microscopy Environment: + - Glencoe Software, Inc. + - University of Dundee + - German BioImaging e.V. +All rights reserved. -Contributions to Specifications are made under the -[W3C CLA](https://www.w3.org/community/about/agreements/cla/). +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -Contributions to Software, including sample implementations, are under the -[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 6ae13169..d0d38d56 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,41 @@ [![DOI](https://zenodo.org/badge/313652456.svg)](https://zenodo.org/badge/latestdoi/313652456) -# ome-ngff +# Contributing -[Next-generation file format (NGFF) specifications](https://ngff.openmicroscopy.org/latest/) for storing bioimaging data in the cloud. +We welcome contributions from anyone! Create Issues and PRs on this repo for content on https://ngff.openmicroscopy.org. -## Editing +Content can be created using Markdown, HTML, and [MyST](https://myst-parser.readthedocs.io/en/latest/) syntax. -Specifications are written in markdown, or technically -[bikeshed](https://github.com/tabatkins/bikeshed) -- a markdown document, with -special extensions understood by the bikeshed tool. The bikeshed tool is run -during the Sphinx build step (see conf.py). +See also [CONTRIBUTING.md](./CONTRIBUTING.md) -[Learn more about bikeshed](https://w3c-ccg.github.io/bikeshed_instructions.html) +# Specifications -## Reviewing +[Next-generation file format (NGFF) specifications](https://ngff.openmicroscopy.org/latest/) for storing bioimaging data in the cloud. -Commits on GitHub can be viewed at PR-numbered URLs provided by readthedocs. -Additionally, bikeshed pages can be viewed using web services from the W3C: +Specifications have been moved to [ome/ngff-spec](https://github.com/ome/ngff-spec). - * Rendered page: http://api.csswg.org/bikeshed/?url=https://raw.githubusercontent.com/ome/ngff/master/0.2/index.bs - * Diff: https://services.w3.org/htmldiff?doc1=https%3A%2F%2Fngff.openmicroscopy.org%2F0.2%2F&doc2=http%3A%2F%2Fapi.csswg.org%2Fbikeshed%2F%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fome%2Fngff%2Fmaster%2Flatest%2Findex.bs +### Editing specifications -## New version +Specifications are written in markdown, or technically +[bikeshed](https://github.com/tabatkins/bikeshed) -- a markdown document, with +special extensions understood by the bikeshed tool. The bikeshed tool is run +during the Sphinx build step (see conf.py). -* Make new changes to `latest/index.bs` -* Update changelog at the bottom of `latest/index.bs` -* Find references to previous version and _in most cases_, bump to the current version. +# RFCs -## JSON schemas +Requests for comments (RFCs) are used to discuss and capture high-level decisions within the NGFF community. -For each top-level metadata key of the OME-NGFF specification, JSON schemas are maintained -for each version of the specification and stored under `$VERSION/schemas/` or `latest/schemas/`. -Tests validating these schemas must be implemented to follow principles of the -[JSON schema test suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite) -and stored under `$VERSION/tests/` or `latest/tests/` to allow their execution on each CI build. +RFCs are contained under the `rfc` directory at the moment but may be moved out into a separate repo in the future. -All official example snippets must also be extracted and managed as separate JSON files under -`$VERSION/examples/` or `latest/examples/`, validated by the appropriate schema by adding a -`.config.json` file specifying the JSON schema to use and included in the -specification document using the -[include-code](https://tabatkins.github.io/bikeshed/#including-code) directive. +# Contributors -The official OME-NGFF JSON schemas are published under -https://ngff.openmicroscopy.org//schemas/.schema. + + + -# Release process + + -* For patch releases, bump the submodule for the given version. -* For minor and major versions, add a new submodule location for the version branch. -* Check and update: - - copyright.include - - the head matter in the `$VERSION`ed file - * Use: `Status: w3c/CG-FINAL` - * Update `URL: ` - * Use the following `Status Text:`: "This is the $VERSION release of this specification. - Migration scripts will be provided between numbered versions. Data written with the latest version - (an "editor's draft") will not necessarily be supported." - - update the footer matter in the `$VERSION`ed file - - Version in the citation block including release date + -# Citing -Please see https://ngff.openmicroscopy.org/latest#citing for the latest -citation. diff --git a/contributing/index.md b/contributing/index.md index 59e91a3c..0ca43720 100644 --- a/contributing/index.md +++ b/contributing/index.md @@ -24,6 +24,4 @@ relevant RFC. A template is also available for formatting your comment: ## Changes to this website -Any minor fixes/improvements to these pages should be opened as an issue in the -[`ome/ngff repository`](https://github.com/ome/ngff), and be fixed/implemented -with a pull request in the [`ome/ngff` repository](https://github.com/ome/ngff). +The repository for this website is [ome/ngff](https://github.com/ome/ngff). Contributions to these pages are welcome as issues or PRs. Please read the [contributing guide](https://github.com/ome/ngff/blob/main/CONTRIBUTING.md).