Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/InseeFrLab/onyxia
Browse files Browse the repository at this point in the history
  • Loading branch information
garronej committed Oct 15, 2023
2 parents 8edc926 + c8890a1 commit 3ebe5ff
Show file tree
Hide file tree
Showing 7 changed files with 248 additions and 2 deletions.
38 changes: 38 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Code of Conduct for Onyxia

## Introduction

At Onyxia, we value our community and its members. Our commitment to fostering an open and welcoming environment stands as a testament to the foundational principles we believe in: open collaboration, user empowerment, no vendor lock-in, and reversibility.

This Code of Conduct outlines the expectations for behavior within our community, as well as the steps for reporting unacceptable behavior. It applies to all members of the community, including maintainers, contributors, users, and anyone involved in Onyxia discussions and contributions.

## Behavior Expectations

1. **Open Collaboration:** Share your knowledge willingly. Respect the contributions of others and provide constructive feedback.
2. **Respect:** Understand and respect differences. Discrimination, harassment, or any kind of negative behavior will not be tolerated.
3. **Empowerment:** Encourage and support other community members, ensuring they feel valued and welcomed.
4. **No Vendor Bias:** Focus on the betterment of Onyxia. Avoid pushing vendor-specific agendas or biases.

## Unacceptable Behavior

1. **Disrespectful Conduct:** Use of derogatory language, personal attacks, trolling, or any form of harassment.
2. **Exclusivity:** Discrimination based on gender, sexual orientation, disability, personal appearance, body size, race, or religion.
3. **Misrepresentation:** Representing the project or its members without explicit permission.
4. **Disruption:** Disrupting discussions, talks, or any other event associated with Onyxia.
5. **Information Misuse:** Unauthorized publication of private communication or data.

## Reporting Issues

If you experience or witness unacceptable behavior—or have any other concerns—please report it by contacting the project team at [[email protected]]. All reports will be handled with discretion.

## Consequences for Unacceptable Behavior

Unacceptable behavior from any community member will not be tolerated. Those who violate the Code of Conduct may face repercussions deemed appropriate by the Core Team, ranging from a warning to expulsion from the project, depending on the severity of the offense.

## Addressing Grievances

If you feel you've been falsely or unfairly accused of violating this Code of Conduct, please notify the Core Team with a concise description of your grievance.

## Contact Info

For any questions about this Code of Conduct, you can reach the Core Team at [[email protected]].
34 changes: 34 additions & 0 deletions DCO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
100 changes: 100 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# Governance of Onyxia

## Introduction

Onyxia is not just a project, but a testament to the future of open collaboration in the data realm. Inspired by the prolific "mother of dragons", Onyxia's vision is to give life to myriad data services, while seamlessly integrating other open-source tools. We're not here to chain or limit, but to empower. This is a project that believes in true freedom of data service usage, ensuring users enjoy a rich experience without getting ensnared into vendor-specific boundaries.

## Foundational Principles

1. **Open Collaboration:** Harnessing the combined strengths of diverse open-source tools to foster continuous innovation.
2. **User Empowerment:** Ensuring a user experience that is both enriching and liberating.
3. **Sustainability:** Committing to the long-term growth and vibrancy of the project and its community.
4. **No Vendor Lock-In:** Guaranteeing flexibility and freedom of choice, allowing users to shape their experience without constraints.
5. **Reversibility and Flexibility:** Committing to a design that's not overly attached to a single interface, fostering adaptability and accommodating future enhancements.

## Onyxia's Repository Structure

Onyxia is structured as a multi-repository project to ensure modular development and streamlined deployment processes. This structure allows each component to be developed, tested, and deployed independently, offering both flexibility and scalability to the entire project.

- [Main Repository - Onyxia Software](https://github.com/Inseefrlab/Onyxia)
This is the core repository of Onyxia, where the main software resides. It contains the source code, configurations, and documentation for Onyxia's primary functionalities. Any enhancements, bug fixes, or major features related to the core platform are generally contributed to this repository.

- [Docker Images Repository - Web IDE Stack](https://github.com/Inseefrlab/images-datascience)
Complementing the main software, Onyxia also has a dedicated repository for its stack of Docker images. These images are tailored for providing many Web IDE (Integrated Development Environment) to users. It ensures that users have all the tools and environments they need, right out of the box. The repository contains the Dockerfiles, associated scripts, and other necessary assets to build, test, and publish these images.

- [Helm Charts Repository](https://github.com/inseefrlab/helm-charts-interactive-services)
Helm charts are instrumental in deploying applications in Kubernetes environments. Onyxia has a separate repository dedicated to Helm charts for its Docker images. These charts encapsulate the deployment specifications, dependencies, and configurations, making it a breeze for users or administrators to deploy Onyxia's components in their Kubernetes clusters.

By separating these components into distinct repositories, Onyxia ensures a clean separation of concerns, making it easier for developers to work on specific aspects without affecting others. Additionally, it facilitates version control, dependency management, and continuous integration/continuous deployment (CI/CD) processes, ensuring that Onyxia remains robust and state-of-the-art.

## Core Team

### Roles and Responsibilities

- **Drive Vision:** Uphold and steer Onyxia's overarching mission.
- **Repository Oversight:** Ensure a consistent vision across all repositories.
- **Conflict Resolution:** Mediate disagreements and guide towards consensus.

## Core Team Members

| Name | Affiliation | GitHub ID |
| -------------- | ----------- | ---------- |
| Frédéric Comte | Insee | [@fcomte](https://github.com/fcomte) |
| Joseph Garrone | Insee | [@garonnej](https://github.com/garronej) |
| Olivier Levitt | Insee | [@olevitt](https://github.com/olevitt) |
| Romain Lesur | Insee | [@rlesur](https://github.com/rlesur) |

## Repository Maintainers

### Roles and Responsibilities

- **Repo-specific Vision:** Direct the path for their designated repository.
- **Review and Merge:** Oversee pull requests, manage issues, and ensure quality.
- **Align with Core Team:** Ensure consistent progress in line with Onyxia's broader goals.

### List of maintainers

For each repository, a file named Maintainers.md must be created with the following format:


| Name | GitHub ID | Affiliation | Role
| -------------- | ----------- | ---------- | --------- |
| [Name of Maintainer] | @GitHubID | [Affiliation] | Lead Maintainer |
| ... | ... | ... | Co maintainer |

- [Onyxia maintainers](https://github.com/InseeFrLab/onyxia/blob/main/MAINTAINERS.md)
- [Image datascience maintainers](https://github.com/InseeFrLab/images-datascience/blob/main/MAINTAINERS.md)
- [Helm charts maintainers](https://github.com/InseeFrLab/helm-charts-interactive-services/blob/main/MAINTAINERS.md)

## Contributors

### Roles and Responsibilities

- **Code Contributions:** Offer fixes, new features, and other valuable additions.
- **Issue Reporting:** Highlight bugs and propose enhancements.
- **Community Participation:** Engage in discussions, share ideas, and uphold Onyxia's core values.

## Decision Making

- **Consensus:** Prioritize decisions through collaborative discussion.
- **Voting within Repositories:** If consensus isn't reached, Maintainers can instigate a vote.
- **Veto Rights:** The Core Team possesses veto rights for critical project decisions.

## Communication

- **Public Interaction:** GitHub remains our primary platform for repository-specific conversations.
- **Inter-repo Coordination:** Regular virtual meetings ensure synchronization and alignment.
- **Real-time Engagement:** [Slack channels](https://join.slack.com/t/3innovation/shared_invite/zt-1hnzukjcn-6biCSmVy4qvyDGwbNI~sWg) for immediate communication and collaboration.

## Team Expansion

- **Promoting Maintainers:** Active contributors can be nominated to assume the role of Maintainers.
- **Core Team Induction:** Standout contributors may be invited to the Core Team, amplifying Onyxia's vision.

## Code of Conduct

Each Onyxia repository adheres to a unified Code of Conduct, ensuring a respectful and inclusive community for all.

## Revising Governance

The landscape of open-source and data services is ever-evolving. Governance adaptations may be proposed by Core Team members to remain current and effective.
41 changes: 41 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Onyxia Maintainers

This document lists the maintainers of the Onyxia project. The maintainers are responsible for guiding the project, reviewing and merging PRs, addressing issues, and overall ensuring the health and progress of the project.

## Active Maintainers

| Name | GitHub Username | Affiliation | Role |
| ---------------- | ----------------- | ------------- | -------------- |
| Joseph Garrone | @garronej | Insee | Lead Maintainer |
| Dylan Decrulle | @ddecrulle | Insee | Co-maintainer |
| Levitt Olivier | @olevitt | Insee | Co-maintainer |

## Emeritus Maintainers

These are previous maintainers who have stepped down from their role but are recognized for their contributions.

| Name | GitHub Username |
| ---------------- | ----------------- |
| Genevois Renaud | @renaud23 |
| Hufschmitt Marc | @marchufschmitt |

## Becoming a Maintainer

If you're interested in becoming a maintainer, please reach out to one of the current maintainers. Generally, potential maintainers will be selected based on:

- Long-term consistent contributions to the project.
- Deep understanding of the codebase, tools, and applications.
- Commitment to the project's success.
- Alignment with the project's goals and philosophy.

## Maintainer Responsibilities

- Review and merge PRs
- Address and respond to issues
- Guide the project's vision and direction
- Ensure the quality and security of the codebase
- Communicate with the community

---

Thank you to all of our maintainers, past and present, for their commitment and hard work!
1 change: 1 addition & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Roadmap is [here](https://docs.onyxia.sh/roadmap)
32 changes: 32 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Security Policy for Onyxia

## Supported Versions

We only support the last version of Onyxia

## Reporting a Vulnerability

We take the security of Onyxia seriously. If you believe you've found a security vulnerability in Onyxia, we encourage you to let us know right away.

### Steps:

1. **Please do not report security vulnerabilities through public GitHub issues.**
2. Instead, send an email to [[email protected]] with a detailed description of the issue.
3. Include steps to reproduce, if possible. This will help us resolve any potential vulnerabilities faster.
4. We will acknowledge receipt of your vulnerability report and will send you regular updates about our progress.

### Our Commitment:

- If you choose to share your contact information, we will acknowledge your report within 24 hours.
- We will give you an estimate of how long it will take to address the vulnerability.
- We'll notify you when the vulnerability is fixed.

You can report vulnerabilities anonymously if you wish, but we encourage you to share your contact information so we can reach out if we need additional information.

## Disclosure Policy

Once we've assessed a reported vulnerability, we'll make every effort to keep affected users informed and coordinate the disclosure of the vulnerability with you.

---

Thank you for helping to keep Onyxia and our users safe!
4 changes: 2 additions & 2 deletions publiccode.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ maintenance:
type: "internal"

contacts:
- name: Frederic Compte
email: "frederic.compte@insee.fr"
- name: Frederic Comte
email: "frederic.comte@insee.fr"
affiliation: INSEE
phone: "+33627137276"
- name: Joseph Garrone
Expand Down

0 comments on commit 3ebe5ff

Please sign in to comment.