From 524ffc3d06f5403661642f1995e248a37fc0f055 Mon Sep 17 00:00:00 2001 From: Jennifer Date: Tue, 10 Jul 2018 17:21:14 -0700 Subject: [PATCH] removed empty/old readme, updated how-to-gitea, added preflight to this repo. --- README.orig.md | 3 --- how-to-gitea.md | 12 ++++++++++++ preflight.md | 4 ++-- 3 files changed, 14 insertions(+), 5 deletions(-) delete mode 100644 README.orig.md diff --git a/README.orig.md b/README.orig.md deleted file mode 100644 index 0429a08..0000000 --- a/README.orig.md +++ /dev/null @@ -1,3 +0,0 @@ -# Docs - -The core documentation on how to setup an SBC as a lolipop cloud \ No newline at end of file diff --git a/how-to-gitea.md b/how-to-gitea.md index c5e4634..c0ac838 100644 --- a/how-to-gitea.md +++ b/how-to-gitea.md @@ -1,3 +1,15 @@ +# You don't have to learn git or Gitea to contribute... +If you would like to walk through the git contribution process to submit changes, skip this section and move down to the [cheatsheat](#"Gitea cheat sheet for beginners and the forgetful"). But if you have no interest in expending that much energy, we don't blame you. You can skip git entirely and submit a detailed suggestion in the form of a ticket (or "issue," in git-speak). + +You will need to [create an account here (link)](https://git.lollipop.holdmybeer.solutions/user/sign_up) and then log in, if you have not already. + +Open the specific [Lollipop Repository (such as lolipop_lan_cloud, website, or docs) (link)](https://git.lollipop.holdmybeer.solutions/) you would like to improve. Then click on the "issues" tab. + +It is good practice to use the search box to search existing issues (with a keyword or two) ensure you're not making a suggestion that's already been made-- and if your suggestion has already been made, we would love if you would add your thoughts and comments to the existing ticket. The more information we have, the easier it will be to implement the request (as long as it is technically feasible). This also helps us understand how popular a request is, and helps us prioritize our updates. + +If the issue does not exist already, select the "new issue" button, and provide as much information as you are able. Be sure to include a descriptive title! When you're ready, click "create issue" and leave the rest to us. + + # Gitea cheat sheet for beginners and the forgetful Below is the basic Gitea workflow, to help you with your contributions. But do not hesitate to reach out to any of the organizers for help! We're happy to walk you through any or all of this, no matter what your experience level. If you've never even heard of Gitea before, we'd love to help you submit your first contribution! diff --git a/preflight.md b/preflight.md index 4cbf1a2..05d92c7 100644 --- a/preflight.md +++ b/preflight.md @@ -15,7 +15,7 @@ Some things you may or may not want to consider ahead of time ### Offical Support -Be sure to check OpenWRT/Armbian for your chosen router/boards support status. A number are going to be officially supported while others will have development snapshots avilable. +Be sure to check OpenWRT/Armbian for your chosen router/boards support status. A number are going to be officially supported while others will have development snapshots available. ## Domain @@ -30,7 +30,7 @@ A couple of good registrars for registering a domain ### TLDs (Top Level Domains) -Some good TLDs for a lolipop device +Some good TLD ideas for a Lollipop device - .zone - .host