A template for OCI proposals

This repository establishes a base for OCI proposals and drafts using respec as a foundation.

This repo includes a number of defaults for the respec template. See respecConfig for the exact configuration.

🔋 Getting started

1. Click on 'Use this template' in the github interface
2. Create the new templated repository in your user namespace or OCI namespace
3. Open index.html and replace the following variables with your content
   1. Spec Information:
      • SPEC_TITLE
      • SPEC_SUBTITLE
   2. Author Information:
      • YOUR_NAME
      • YOUR_WEBSITE
      • YOUR_COMPANY
      • YOUR_COMPANY_WEBSITE
   3. Repository Information:
      • REPO_LINK
      • PAGE_URL
4. Open the index.html file in your local browser to preview your draft
5. Once you are ready, push your changes to your repo.

✍️ Working with this template

Please see the respec documentation for an in-depth explanation of all possible options for writing your proposal. However, a good base can be established by expanding your abstraction definition and including new sections for your proposal. Some examples are already included in index.html.

📖 Github Pages

When you update the main branch of your proposal repository, the resulting content will automatically published to a github page that you can share. Using the default configuration your page should be accessible at:

https://<user>.github.io/<repository>

To activate this feature navigate to Settings > Pages > Source: select Branch 'gh-pages'

---

Keep the content below within each repo.

🔗 Web version of this Repo

Go to Enter repo name and adjust link

🤝 Contributing

OCI encourages contributions from OCI member and non-member companies and individuals. Please send issues and pull requests by following our processes and agreements. Feel free to check the issues page.

By contributing, companies and individuals certify the assertions made in the Developer's Certificate of Origin.

🏷️ Licence

By submitting their contribution to OCI, the contributor certifies that they have the right to submit it under the open source license indicated here.

This project is Apache 2.0-licensed.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, material distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2022 Named editors. Contributors to OCI.