Browse Source

Remove legacy documentation (#85)

swap
Mayank Chhabra 5 years ago
committed by GitHub
parent
commit
fd7f5fa8fe
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 76
      CODE_OF_CONDUCT.md
  2. 25
      CONTRIBUTING.md
  3. 15
      README.md

76
CODE_OF_CONDUCT.md

@ -1,76 +0,0 @@
# 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 one of the contributors (i.e. [@nolim1t](https://github.com/nolim1t) [@mayankchhabra](https://github.com/mayankchhabra)). 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

25
CONTRIBUTING.md

@ -1,25 +0,0 @@
## How to contribute
#### **Did you find a bug?**
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/getumbrel/umbrel-os/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/getumbrel/umbrel-os/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and try to include a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
#### **Did you write a patch that fixes a bug?**
* Open a new GitHub pull request with the patch.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
* If you haven't done a test build yet, please mention this in the pull request. This will save a world of pain for future builds. There is no regression testing suite set up yet but this is something that we're looking into. Contributions are welcome.
#### **I'm not a developer, what can I do to help?**
We could definetely use some QA support on this project (as its painstakingly manual). See getting in touch below or just [create an issue](https://github.com/getumbrel/umbrel-os/issues/new) and tag it with question.
#### **Getting in touch**
We accept contributions of all kinds, please contact us - [maintainer list here](https://github.com/getumbrel/umbrel-os/graphs/contributors)

15
README.md

@ -62,23 +62,12 @@ After the build completes (it can take a looooooong time), the image will be ins
The `config` file has system defaults which are used when building the image and for automated builds.
- `UMBREL_VERSION` - Use this to install the specific [Umbrel](https://github.com/getumbrel/umbrel) version
- `UMBREL_VERSION` - To install the specific [Umbrel](https://github.com/getumbrel/umbrel) version.
- `GITHUB_USERNAME` - Use this if you want to automatically login to your node without typing a password (used at build time).
- `GITHUB_USERNAME` - To automatically login to your Umbrel without typing a password.
Other Raspbian-related stuff can be found in [Raspbian's documentation](https://github.com/RPi-Distro/pi-gen/blob/master/README.md) which is still applicable.
**Post bootup checks**
For building an API (or scripting), look in `/home/umbrel/umbrel/statuses` for the following files
- `disk-partitioned`: meaning the disk is partitioned.
- `service-configured`: meaning the umbrel system bootup service is configured and running.
The above variables control whether or not the umbrel startup script is run (for SD Card safety).
If you want to overricde the checks, please delete ```service-configured``` file and add a ```disk-partitioned```, and then reinstall/configure [Umbrel](https://github.com/getumbrel/umbrel). Then run ```/etc/rc.local``` as root again (or restart your box)
---
### ⚡️ Don't be too reckless

Loading…
Cancel
Save