Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add community documents #777

Merged
merged 1 commit into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/install_ramalama.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ jobs:
chmod +x install.sh
sudo ./install.sh -l

- name: Ramalama info
- name: RamaLama info
run: |
ramalama info

- name: Ramalama info
- name: RamaLama pull
run: |
ramalama pull tinyllama
71 changes: 71 additions & 0 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
![Containers Logo](https://github.com/containers/common/blob/main/logos/containers-full-horiz.png)
## Containers Community Code of Conduct

### Contributor Code of Conduct

As contributors and maintainers of the projects under the [Containers](https://github.com/containers) repository,
and in the interest of fostering an open and welcoming community, we pledge to
respect all people who contribute through reporting issues, posting feature
requests, updating documentation, submitting pull requests or patches, and other
activities to any of the projects under the containers umbrella. These projects
include Buildah, Conmon, Image, Podman, RamaLama, Storage, Skopeo, et al.
as found [here](https://github.com/containers).

We are committed to making participation in these projects a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age,
religion, or nationality.

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery.
* Personal attacks.
* Trolling or insulting/derogatory comments.
* Public or private harassment.
* Publishing other's private information, such as physical or electronic addresses,
without explicit permission.
* Other unethical or unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are not
aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers
commit themselves to fairly and consistently applying these principles to every aspect
of managing their project. Project maintainers who do not follow or enforce the Code of
Conduct may be permanently removed from the project team or teams if they are in multiple
projects.

This code of conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a maintainer of the project, the Container Organization's Code of Conduct Mailing List <[email protected]> ([List Members](#List-Members)), Dan Walsh <[email protected]>, and/or Tom Sweeney <[email protected]>.


### Containers Events Code of Conduct

Containers events are working conferences intended for professional networking and collaboration in the
Containers community. Attendees are expected to behave according to professional standards and in accordance
with their employer's policies on appropriate workplace behavior.

While at Containers events or related social networking opportunities, attendees should not engage in
discriminatory or offensive speech or actions regarding gender, sexuality, race, or religion. Speakers should
be especially aware of these concerns.

The maintainers of the Containers projects do not condone any statements by speakers contrary to these standards.
The maintainers of the Containers projects reserves the right to deny entrance and/or eject from an event
(without refund) any individual found to be engaging in discriminatory or offensive speech or actions.

Please bring any concerns to the immediate attention of a maintainer of the project, the Container Organization's Code of Conduct Mailing List <[email protected]> ([List Members](#List-Members)), Dan Walsh <[email protected]>, and/or Tom Sweeney <[email protected]>.

This Code of Conduct was adapted from the [CNCF Community Code of Conduct v1.0](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

### List Members

| List Member | email |
| ------------ | ------ |
| Chris Evich | [email protected] |
| Dan Walsh | [email protected] |
| Lokesh Mandvekar | [email protected] |
| Mohan Boddu | [email protected] |
| Paul Holzinger | [email protected] |
| Preethi Thomas | [email protected] |
| Tom Sweeney | [email protected] |
18 changes: 15 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Below summarizes the processes that we follow.
* [Contributing To RamaLama](#contributing-to-ramalama)
* [Submitting Pull Requests](#submitting-pull-requests)
* [Communications](#communications)
* [Code of Conduct](#code-of-conduct)


## Reporting Issues

Expand Down Expand Up @@ -130,7 +132,7 @@ To set up `podman farm` you need to first have `podman` installed on systems wit
podman farm build -t <registry-of-choice>/<image-name> -f path/to/Containerfile ./path/
```

Example using an Apple Silicon based machine as the workstation, and an Intel Linux machine as a remote host with IP 10.11.12.13:
Example using an Apple Silicon based machine as the workstation, and an Intel Linux machine as a remote host with IP 10.11.12.13:

1. Set up Podman Farm -

Expand Down Expand Up @@ -276,9 +278,9 @@ The following git config settings can be used to add a pretty format for outputt

```
[core]
abbrev = 12
abbrev = 12
[pretty]
fixes = Fixes: %h (\"%s\")
fixes = Fixes: %h (\"%s\")
```

### Sign your PRs
Expand Down Expand Up @@ -382,6 +384,16 @@ and
[PRs](https://github.com/containers/ramalama/pulls)
tracking system.

## Code of Conduct

As contributors and maintainers of the projects under the [Containers](https://github.com/containers) repository,
and in the interest of fostering an open and welcoming community, we pledge to
respect all people who contribute through reporting issues, posting feature
requests, updating documentation, submitting pull requests or patches, and other
activities to any of the projects under the containers umbrella. The full code of conduct guidelines can be
found [here](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md).


### Bot Interactions

The primary human-interface is through comments in pull-requests.
Expand Down
3 changes: 3 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Security and Disclosure Information Policy for the RamaLama Project

The RamaLama Project follows the [Security and Disclosure Information Policy](https://github.com/containers/common/blob/main/SECURITY.md) for the Containers Projects.
2 changes: 1 addition & 1 deletion docs/ramalama-info.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The `Runtime` field indicates which backend engine is used to execute the AI mod
- `llama.cpp`: Uses the llama.cpp library for model execution
- `vllm`: Uses the vLLM library for model execution

The `Store` field indicates the directory path where Ramalama stores its persistent data, including downloaded models, configuration files, and cached data. By default, this is located in the user's local share directory.
The `Store` field indicates the directory path where RamaLama stores its persistent data, including downloaded models, configuration files, and cached data. By default, this is located in the user's local share directory.

The `UseContainer` field indicates whether RamaLama will use containers or run the AI Models natively.

Expand Down
Loading