diff --git a/compass.md b/compass.md new file mode 100644 index 0000000..eeff7d4 --- /dev/null +++ b/compass.md @@ -0,0 +1,57 @@ +--- +title: OXA Team Compass +--- + +The OXA Team Compass is the central resource for governance, planning, and community engagement for the Open Exchange Architecture (OXA) project. + +The OXA project is stewarded by the [Continuous Science Foundation](https://continuousfoundation.org), a grassroots, community-driven organization that brings together researchers, tool builders, publishers, and standards groups to support modular, continuous ways of publishing research. + +## Purpose + +This compass serves as a guide for: + +- **Steering Council** membership and governance for the OXA project +- **Decision-making processes** and policies +- **Planning documents** and roadmaps +- **Meeting agendas** and minutes +- **Community resources** and contribution guidelines + +## Steering Council + +The OXA Steering Council is responsible for strategic direction, governance decisions, and ensuring the long-term health of the OXA project. + +### Current Members + +- **Nokome Bentley** ([\@nokome](https://github.com/nokome)) — Steering Council Member +- **Rowan Cockett** ([\@rowanc1](https://github.com/rowanc1)) — Steering Council Member +- **Coming Soon** — Steering Council Member +- **Coming Soon** — Steering Council Member + +## Governance + +### Decision-Making + +Changes and improvements to OXA are completed through a community [Request For Comment](./rfc.md) process. The Steering Council tries to make all decisions through consensus. When consensus cannot be reached, decisions are made by majority vote of the Steering Council. + +### Membership + +Steering Council members are selected based on their commitment to the OXA project, technical expertise, and ability to represent diverse perspectives in the scientific publishing ecosystem. New members are added through a nomination and voting process by existing Steering Council members. + +### Term Length + +Steering Council members serve for renewable terms, typically two years, with staggered terms to ensure continuity. + +## Planning, Practices & Contributing + +- [OXA Roadmap & Planning](./planning.md) for a general roadmap of where we plan to take the project +- [Contributing Guide](./contributing.md) for repository guides and code organization +- [Practices](./practices.md) for development workflows and processes +- [Community Meetings](./meetings.md) for information on past and upcoming meetings + +## Resources + +### Documentation + +- [OXA](https://oxa.dev) — The main OXA specification and documentation +- [OXA Repository](https://github.com/oxa-dev/oxa) — Source code and schema definitions +- [Contributing Guide](./contributing.md) has additional information and pointers diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..72f4dd3 --- /dev/null +++ b/contributing.md @@ -0,0 +1,55 @@ +--- +title: Contributing to and improving OXA +short_title: Contributing +--- + +OXA is an open community specification. We welcome contributions from tool builders, publishers, repositories, and researchers who want to advance interoperable, open science. + +Ways to contribute: + +- **Extend the schema** for your tools and use cases +- **Discuss interoperability** on GitHub issues +- **Submit examples** and validators +- **Propose enhancements** to the specification +- **Participate in meetings** and discussions + +See the main OXA repository's [Contributing Guide](https://github.com/oxa-dev/oxa/blob/main/CONTRIBUTING.md) for more details on how to get involved. + +## Communication Channels + +- [GitHub Discussions](https://github.com/orgs/oxa-dev/discussions) for general discussion and Q&A +- [GitHub Issues](https://github.com/oxa-dev/oxa/issues): Bug reports and feature requests for OXA +- [Discord](https://discord.oxa.dev): Real-time community chat +- [Meetings](./meetings.md): Regular community calls + +## Outreach + +We welcome you to help amplify the project through the following mechanisms: + +- Conference presentations and workshops +- Blog posts and articles +- Tutorial videos and examples +- Integration showcases + +Please reach out through [Discord](https://discord.oxa.dev) to ask if there are materials that you can build on. + +(repositories)= + +## Repositories + +The OXA project is organized across multiple repositories: + + +: Contains information to point to various resources in the ecosystem and is deployed to + + +: Information about the request-for-comment process and accepted RFCs + + +: Contains the schemas, types (Python, Rust, Typescript) and command-line tools for validation + + +: Cloudflare workers for the website, for public access to the published schemas + + +: Blog content, posted to diff --git a/index.md b/index.md index 23a51aa..d0ac997 100644 --- a/index.md +++ b/index.md @@ -55,4 +55,6 @@ We welcome contributions from tool builders, publishers, and researchers who wan > **Join us in building the foundation of a more connected scientific ecosystem.** -- [Slack](https://slack.continuousfoundation.org) +For discussion, updates, and to connect with the OXA community, join our [Discord server](https://discord.oxa.dev). + +Find more ways to contribute and get involved in the [Contributing Guide](./contributing.md). diff --git a/meetings.md b/meetings.md new file mode 100644 index 0000000..89dfe39 --- /dev/null +++ b/meetings.md @@ -0,0 +1,18 @@ +--- +title: Community Meetings +short_title: Meetings +--- + +### Meeting Schedule + +Regular Steering Council meetings are held to discuss project direction, review proposals, and make governance decisions. Meeting details will be documented here. + +:::{warning} We have no meetings scheduled +We aim to start these in Q1 2026 +::: + +### Agendas and Minutes + +Meeting agendas and minutes are archived in the meetings directory in the compass. + +Join [Discord](https://discord.oxa.dev) to be updated. diff --git a/meetings/README.md b/meetings/README.md new file mode 100644 index 0000000..10848f0 --- /dev/null +++ b/meetings/README.md @@ -0,0 +1,50 @@ +# Meeting Notes + +This directory contains agendas and minutes from OXA Steering Council and community meetings. + +## Structure + +Meeting notes are organized by year: + +``` +meetings/ +├── 2025/ +│ └── 2025-01-XX.md +└── README.md +``` + +## Meeting Notes Format + +Each meeting note should follow this format: + +```markdown +# Meeting Title - YYYY-MM-DD + +## Attendees + +- Name (Organization) +- Name (Organization) + +## Agenda + +1. Topic 1 +2. Topic 2 +3. ... + +## Discussion + +### Topic 1 + +- Discussion points +- Decisions made + +### Topic 2 + +- Discussion points +- Action items + +## Action Items + +- [ ] Action item 1 - Assignee - Due date +- [ ] Action item 2 - Assignee - Due date +``` diff --git a/myst.yml b/myst.yml index 71260a4..045a43f 100644 --- a/myst.yml +++ b/myst.yml @@ -4,12 +4,26 @@ project: id: 872d9342-8932-4bb2-a1e0-91b3861cef85 title: Open Exchange Architecture banner: ./banner.png + github: https://github.com/oxa-dev/compass abbreviations: OXA: Open Exchange Architecture AST: Abstract Syntax Tree JATS: Journal Article Tag Suite CC: Creative Commons JSON: JavaScript Object Notation + RFC: Request For Comment + toc: + - file: index.md + - title: Governance + children: + - file: compass.md + - file: contributing.md + - file: practices.md + - file: rfc.md + - title: Meetings + children: + - file: meetings.md + - file: meetings/README.md site: template: book-theme # options: diff --git a/practices.md b/practices.md new file mode 100644 index 0000000..414bd38 --- /dev/null +++ b/practices.md @@ -0,0 +1,39 @@ +--- +title: Practices & Processes +--- + +These are guidelines not rules; use your best judgment. +If you are unsure or want to talk something through, ask questions in [Discord](https://discord.oxa.dev). + +## Development Practices + +### Issue Tracking + +- Use GitHub Issues for bug reports, feature requests; see [repository list](#repositories) +- Ask public questions in [GitHub Discussions](https://github.com/orgs/oxa-dev/discussions) + +### Branching Strategy + +- `main` branch: Stable, release-ready code +- Use **squash merges** to keep the main branch simple + +### Code Reviews + +- Changes should have pull request review +- At least one Steering Council member approval for significant changes +- Automated testing should pass before merge +- Merge optimistically, especially if you are building on the change +- If you need a review/merge and aren't getting attention, send a message in [Discord](https://discord.oxa.dev) + +## Decision-Making Process + +### Proposals + +- Major changes require a proposal document, see the [RFC process](./rfc.md) for more information +- Proposals include motivation, detailed design, alternatives considered, migration path + +### Consensus Building + +- Aim for consensus among active contributors +- If consensus cannot be reached, Steering Council makes final decision +- Decisions are documented and communicated clearly diff --git a/rfc.md b/rfc.md new file mode 100644 index 0000000..2072bcf --- /dev/null +++ b/rfc.md @@ -0,0 +1,7 @@ +--- +title: Request For Comment Process +--- + +### Proposals + +Proposals are discussed in the [RFC](https://github.com/oxa-dev/rfc) repository and in the [Discord](https://discord.oxa.dev) `#rfc` channel. See the [RFC](https://github.com/oxa-dev/rfc) repository for more detailed discussions.