From 25d30ddebc704f0099dd270d101fb06bb295686b Mon Sep 17 00:00:00 2001 From: Gabe Kangas Date: Sat, 20 Jul 2024 08:05:30 -0700 Subject: [PATCH] Point to new project docs pages --- content/contribute.md | 84 +----------------------------------------- content/development.md | 62 +------------------------------ 2 files changed, 4 insertions(+), 142 deletions(-) diff --git a/content/contribute.md b/content/contribute.md index 2566b70815..239c2b31fc 100644 --- a/content/contribute.md +++ b/content/contribute.md @@ -2,86 +2,6 @@ title: Contribute --- -We are open for new contributors to this project. If you have found issues or bugs, -or would like to improve Owncast by sending your code, please visit our GitHub page: + -{{< button href="https://github.com/owncast/owncast" >}}GitHub Repository{{< /button >}} - -The team also gets on Jitsi regularly, so if you want to attend of those meetings, check out [issue #167](https://github.com/owncast/owncast/issues/167) where we coordinate meeting times. - -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -- The use of sexualized language or imagery and unwelcome sexual attention or - advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic - address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -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, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at gabek@real-ity.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq +Click here if you are not redirected. diff --git a/content/development.md b/content/development.md index a33d96a1ad..6fdeead316 100644 --- a/content/development.md +++ b/content/development.md @@ -18,64 +18,6 @@ type: toc toc: true --- -Owncast is a straightforward web application and compared to many projects is very easy to get running locally and contributing to. + -- The backend is written in [Go](https://go.dev/). -- The frontend is written in [React](https://reactjs.org/). - -If you're interested in contributing to Owncast, here's how you can get started. - -## How to start with Frontend development - -The web frontend of Owncast is written in React with TypeScript built using [Next.js](https://nextjs.org/). - -You can browse the React components in the project using our [Storybook](https://owncast.online/components) page to get an idea of how the frontend is structured. - -1. Fork the Owncast repository on Github located at https://github.com/owncast/owncast. -1. Check out your fork locally with `git clone https://github.com/yourusername/owncast`. -1. Create a new branch for your new changes with `git checkout -b my-new-feature`. - -### Run the web project - -1. Change to the `web` directory and install dependencies with `npm install`. -1. Start the development server with `npm run dev`. -1. Open `http://localhost:3000` in your browser. - -You must have an instance of Owncast running locally to connect to. You can run one with `go run main.go` from the root of the repository. Read more details about running development Owncast under the backend section. - -### Learn about how to write React Components with Owncast - -We have a [short document](https://github.com/owncast/owncast/blob/develop/web/components/_COMPONENT_HOW_TO.md) outlining the specifics of the hows and whys of our specific component approach. - -### Use Storybook to update and create components - -Storybook is a tool that allows you to create and test components in isolation. It's a great way to develop new components and test them out without running a copy of the Owncast server. - -1. Run `npm run storybook` to start the Storybook server. -1. Open `http://localhost:6006` in your browser. -1. Navigate the Storybook interface to browse and test components. - -## How to start with Backend development - -The backend of Owncast is written in Go. It operates as a web and API server, inbound RTMP ingestion server, outbound HLS distribution server, and chat server. - -1. Ensure you have the [Go programming language](https://go.dev/dl/) tools installed for your system. -1. Clone the Owncast repository with `git clone https://github.com/owncast/owncast`. -1. A c compiler and tooling must be available on your system. Generally this means installing `gcc` and its development libraries. -1. Run `go run main.go` from the root of the repository. - -### Go Linting - -We use golangci-lint to lint our Go code. While optional, it is a useful tool to assist you in writing better Go code. You can install it from the [golangci-lint](https://golangci-lint.run/welcome/install/#local-installation) website. - -## Run a development stream - -Many features are only enabled when a stream is live. You can run a local stream using any video file you have around by running: - -```bash -./test/ocTestStream.sh somevideofile.mp4 -``` - -## If you haven't yet, find an issue to work on - -Visit our [Good First Issues](https://github.com/owncast/owncast/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) list to find something that might be a good fit for you to start on. Otherwise, feel free to drop into our [community chat](https://owncast.rocket.chat) and say hi and we can get to know you and see where you'd like to take part. +Click here if you are not redirected.