Skip to content

Commit d420d7d

Browse files
tonygermanotonygermano
committed
configure licensing, contributing guidelines, and project metadata
- Add `LICENSE` file implementing a dual-license strategy: CC-BY 4.0 for documentation text and CC0 1.0 for code samples. - Update `README.md` to integrate full contributing guidelines, including DCO sign-off requirements, Bun usage, and protocols for handling third-party code. - Update `package.json` metadata, including the SPDX license identifier `(CC-BY-4.0 AND CC0-1.0)` and `private` flag. Signed-off-by: Tony Germano <tony@germano.name>
1 parent bc44050 commit d420d7d

3 files changed

Lines changed: 179 additions & 13 deletions

File tree

‎LICENSE‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Copyright (c) 2025-present Open Integration Engine Contributors
2+
3+
The content of this repository is bound by the following licenses:
4+
5+
1. DOCUMENTATION & MEDIA
6+
All documentation text, images, and non-code assets are licensed under the
7+
Creative Commons Attribution 4.0 International (CC-BY 4.0) License.
8+
9+
You are free to share and adapt the material as long as you provide attribution
10+
to "Open Integration Engine Contributors" and a link to this repository.
11+
12+
Full license text: https://creativecommons.org/licenses/by/4.0/legalcode
13+
14+
--------------------------------------------------------------------------------
15+
16+
2. CODE SAMPLES & SNIPPETS
17+
All code samples, scripts, configuration files, and inline code snippets
18+
contained within the documentation are dedicated to the public domain under
19+
the Creative Commons CC0 1.0 Universal Public Domain Dedication, unless
20+
otherwise noted in a specific file header included with the code.
21+
22+
You are free to copy, modify, distribute, and perform the work, even for
23+
commercial purposes, all without asking permission and without required
24+
attribution.
25+
26+
Full license text: https://creativecommons.org/publicdomain/zero/1.0/legalcode
27+
28+
--------------------------------------------------------------------------------
29+
30+
DISCLAIMER
31+
THE SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
32+
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
34+
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
35+
OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
36+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
37+
DEALINGS IN THE SOFTWARE.

‎README.md‎

Lines changed: 136 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,144 @@
1-
# Documentation site
1+
# Open Integration Engine™ Documentation
22

3-
## Prerequisites
3+
Welcome to the official documentation repository for **Open Integration Engine™**. This website is built with [VitePress](https://vitepress.dev/) and hosted on GitHub Pages.
44

5-
1. [Node](https://nodejs.org/en/download) of some sort
6-
- _I'm using v22, but I'm sure v24 works too_
7-
2. [Bun](https://bun.sh/)
5+
We welcome contributions from the community! Whether you are fixing a typo, adding a new guide, or sharing a script example, your help is appreciated.
86

9-
## Usage
7+
## Table of Contents
108

11-
Run the development script for hot reloads
12-
```sh
9+
- [Getting Started](#getting-started)
10+
- [Development Workflow](#development-workflow)
11+
- [Writing Guidelines](#writing-guidelines)
12+
- [Legal & Licensing](#legal--licensing)
13+
14+
## Getting Started
15+
16+
### Prerequisites
17+
18+
- **Bun**: This project uses Bun for dependency management and as the runtime. [Install Bun](https://bun.sh/).
19+
20+
### Installation
21+
22+
1. **Fork the repository** to your own GitHub account.
23+
24+
2. **Clone your fork** locally:
25+
26+
```bash
27+
git clone https://github.com/YOUR_USERNAME/docs-website.git
28+
cd docs-website
29+
```
30+
31+
3. **Install dependencies**:
32+
33+
```bash
34+
bun install
35+
```
36+
37+
### Running Locally
38+
39+
To start the local development server with hot-reloading:
40+
41+
```bash
1342
bun run docs:dev
1443
```
15-
RUn the build script fo static ocmpilation
16-
```sh
17-
bun run docs:build
44+
45+
The documentation will be accessible at `http://localhost:5173` (or the port shown in your terminal).
46+
47+
## Development Workflow
48+
49+
1. **Create a Branch:** Always work on a new branch for your changes.
50+
51+
```bash
52+
git checkout -b fix/typo-in-intro
53+
```
54+
55+
2. **Make Changes:** Edit the Markdown files in the `docs` directory.
56+
57+
3. **Update Navigation:** If you created a new file, update `.vitepress/config.mts` to include the new page in the sidebar.
58+
59+
4. **Preview:** Ensure your changes look correct in the local browser preview.
60+
61+
5. **Commit:** [Sign off](#developer-certificate-of-origin-dco) your commits.
62+
63+
```bash
64+
git commit -s -m "docs: fix typo in introduction"
65+
```
66+
67+
6. **Push:** Push your branch to your fork.
68+
69+
7. **Pull Request:** Open a Pull Request (PR) against the `main` branch of this repository.
70+
71+
## Writing Guidelines
72+
73+
* **Markdown Features:** We use [VitePress Markdown](https://vitepress.dev/guide/markdown). This supports standard Markdown as well as advanced features like custom containers, Vue components inside markdown, and more.
74+
* **Code Blocks:** Please use language-specific code fences (e.g., \`\`\`js) for syntax highlighting.
75+
* **Images:** You can store images in the same directory as the markdown file or in the `docs/public` directory. Reference them using relative paths.
76+
77+
## Legal & Licensing
78+
79+
To maintain the open and permissive nature of this documentation, we require all contributors to agree to the project's licensing terms and verify the origin of their contributions.
80+
81+
### 1. Inbound License Agreement
82+
83+
By submitting a Pull Request to this repository, you agree to the following licensing terms:
84+
85+
* **Documentation Content (Text/Media):** You agree to license your text and media contributions under the **Creative Commons Attribution 4.0 International (CC-BY 4.0)** license.
86+
* **New Code Samples:** You agree to dedicate any *original* code you write for this project to the **Public Domain (CC0 1.0 Universal)**.
87+
88+
### 2. Handling Third-Party & Copied Code
89+
90+
If you are including code copied from another open source project (e.g., a community plugin, a library on GitHub, or a Stack Overflow snippet), **you generally do not have the right to re-license it under CC0.**
91+
92+
In these cases, you **must preserve the original license** by including the license header directly inside the code block.
93+
94+
* **Why?** Users often copy code via the "Copy" button on the rendered website. If the license is in a separate file, it gets left behind. The license must travel with the snippet.
95+
* **Requirement:** Identify the license of the code you are copying and ensure it is compatible with distribution in this documentation.
96+
97+
**Example: Including an MPLv2 Licensed Snippet**
98+
99+
```javascript
100+
/*
101+
* Copyright (c) 2026 Original Author Name
102+
* Licensed under the Mozilla Public License 2.0.
103+
* You may not use this file except in compliance with the License.
104+
* You may obtain a copy of the License at [https://mozilla.org/MPL/2.0/](https://mozilla.org/MPL/2.0/)
105+
*/
106+
107+
export function importedCommunityLogic() {
108+
// ... existing code ...
109+
}
110+
```
111+
112+
### 3. Developer Certificate of Origin (DCO)
113+
114+
We require all contributors to sign off on their commits to certify that they have the right to submit the code. We adhere to the **Developer Certificate of Origin (DCO) 1.1**.
115+
116+
By signing off, you certify that:
117+
* You wrote the contribution, or
118+
* You have the right to submit it under the project's open source license (or preserve the existing license as described above).
119+
120+
[Read the full DCO 1.1 text here.](https://developercertificate.org/)
121+
122+
#### How to Sign Off
123+
124+
You must add a `Signed-off-by` trailer to your commit message using your real name and email.
125+
126+
**Important:** The name and email address in the `Signed-off-by` line **must match** the name and email address of the Git commit author.
127+
128+
**Automatic Sign-off:**
129+
130+
```bash
131+
git commit -s -m "docs: add example for custom plugin"
132+
```
133+
134+
**Resulting Commit Message:**
135+
136+
```text
137+
docs: add example for custom plugin
138+
139+
Signed-off-by: Jane Doe <jane.doe@example.com>
18140
```
19141

20-
_Powered by [VitePress](https://vitepress.dev/)_
142+
### 4. Trademarks
143+
144+
Open Integration Engine™, OIE™, and the OIE logo are trademarks of the Open Integration Engine project.

‎package.json‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
{
2+
"name": "open-integration-engine-docs",
3+
"private": true,
4+
"description": "Official documentation for Open Integration Engine™",
5+
"type": "module",
6+
"license": "(CC-BY-4.0 AND CC0-1.0)",
27
"dependencies": {},
38
"devDependencies": {
49
"vitepress": "^1.6.4"
@@ -8,4 +13,4 @@
813
"docs:build": "vitepress build",
914
"docs:preview": "vitepress preview"
1015
}
11-
}
16+
}

0 commit comments

Comments
 (0)