diff --git a/swarmlab/files/help/CreateAccount-Main.png b/swarmlab/files/help/CreateAccount-Main.png new file mode 100644 index 0000000..5a00549 Binary files /dev/null and b/swarmlab/files/help/CreateAccount-Main.png differ diff --git a/swarmlab/files/help/CreateAccount.png b/swarmlab/files/help/CreateAccount.png new file mode 100644 index 0000000..dc6119f Binary files /dev/null and b/swarmlab/files/help/CreateAccount.png differ diff --git a/swarmlab/files/help/Gitea-sign-in-1.png b/swarmlab/files/help/Gitea-sign-in-1.png new file mode 100644 index 0000000..0b8a0ef Binary files /dev/null and b/swarmlab/files/help/Gitea-sign-in-1.png differ diff --git a/swarmlab/files/help/HowTo-gitea.adoc b/swarmlab/files/help/HowTo-gitea.adoc new file mode 100644 index 0000000..4683a5a --- /dev/null +++ b/swarmlab/files/help/HowTo-gitea.adoc @@ -0,0 +1,255 @@ += Usage SwarmLab gitea! +Apostolos rootApostolos@swarmlab.io +// Metadata: +:description: IoT Εισαγωγή στο SwarmLab +:keywords: iot, swarm +:data-uri: +:toc: right +:toc-title: Πίνακας περιεχομένων +:toclevels: 4 +:source-highlighter: highlight +:icons: font +:sectnums: + + + +{empty} + + + +This HowTo teaches you how to Use SwarmLab gitea. + +https://git-scm.com/[Git] is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. + +[[cheat-CreateRepository]] +== create a new repository + +Open https://git.swarmlab.io:3000[Swarmlab Gitea] + +Use any web browser on your computer to join + + +=== Sign In + +.Click on "Sign-in" +image::./Gitea-sign-in-1.png[SwarmLab Sign-in] + +[NOTE] +==== + +.Proxy Error +[source,bash] +---- +Proxy Error + +The proxy server received an invalid response from an upstream server. +The proxy server could not handle the request GET /user/login. + +Reason: Error reading from remote server + +Apache/2.4.25 (Debian) Server at git.swarmlab.io Port 3000 +---- + +Reload Page!!! +==== + + + + +=== New Repository + +==== step 1 + +.New Repository +image::./repo-1.png[SwarmLab New Repository ] + +==== step 2 + +.Create New Repository +image::./repo-2.png[SwarmLab New Repository ] + + + +[[cheat-VloneRepository]] +== clone repository + + +=== git clone + + +==== copy url + +.clone Repositor +image::./repo-clone-1.png[SwarmLab git clone ] + +==== paste url + +- On your computer! + +.git clone +[source,bash] +---- +git clone paste-url-here +---- + +.Install Git +[source.bash] +---- +sudo apt update +sudo apt install git + +---- + +.git error +[NOTE] +==== +The requested URL returned error: 502 + +Try again!!! + +==== + + +== workflow + + +=== add & commit + +You can propose changes (add it to the Index) using + +.git add +[source,bash] +---- +git add +git add * +---- + +This is the first step in the basic git workflow. To actually commit these changes use + +.git status +[NOTE] +==== +git status +==== + +.git commit +[source,bash] +---- +git commit -a -m "Commit message" +---- + +[NOTE] +==== +Now the file is committed to the HEAD, but not in your remote repository yet. +==== + +=== pushing changes + +Your changes are now in the HEAD of your local working copy. + +To send those changes to your remote repository, execute + +.git push +[source,bash] +---- +git push origin master +---- + +Change master to whatever branch you want to push your changes to. + + +=== update + +to update your local repository to the newest commit, execute + +.git pull +[source,bash] +---- +git pull origin +---- + +in your working directory to fetch and merge remote changes. + + +=== log + + +in its simplest form, you can study repository history using.. + +.git log +[source,bash] +---- +git log +---- + +You can add a lot of parameters to make the log look like what you want. +To see only the commits of a certain author: + +.git log +[source,bash] +---- +git log --author=bob +---- + +To see a very compressed log where each commit is one line: + +.git log +[source,bash] +---- +git log --pretty=oneline +---- + +Or maybe you want to see an ASCII art tree of all the branches, decorated with the names of tags and branches: + +.git log +[source,bash] +---- +git log --graph --oneline --decorate --all +---- + +See only which files have changed: + +.git log +[source,bash] +---- +git log --name-status +---- + +These are just a few of the possible parameters you can use. For more, see git log --help + + + +== links & resources + +https://book.git-scm.com/doc[Git Community Book] + +http://marklodato.github.io/visual-git-guide/index-en.html[A Visual Git Reference] + + + + + + + + + + + + + + + + + + + + +:hardbreaks: + +{empty} + +{empty} + +{empty} + +:!hardbreaks: + +''' + diff --git a/swarmlab/files/help/HowTo-register.adoc b/swarmlab/files/help/HowTo-register.adoc new file mode 100644 index 0000000..c67d91c --- /dev/null +++ b/swarmlab/files/help/HowTo-register.adoc @@ -0,0 +1,122 @@ += How to Create an Account on SwarmLab ! +Apostolos rootApostolos@swarmlab.io +// Metadata: +:description: IoT Εισαγωγή στο SwarmLab +:keywords: iot, swarm +:data-uri: +:toc: right +:toc-title: Πίνακας περιεχομένων +:toclevels: 4 +:source-highlighter: highlight +:icons: font +:sectnums: + + + +{empty} + + + +This HowTo teaches you how to sign up for a free personal account on SwarmLab. + +Your free SwarmLab account gives you + +- unlimited access to public and private software repositories +- unlimited access to Lab Instances + +and the ability to collaborate with other users + +[[cheat-Register]] +== How to Create an Account + +=== Go to Application + +- Go to https://git.swarmlab.io:3000 in a web browser. + +[NOTE] +==== +You can use any web browser on your computer to join +==== + +.Click on "Register" +image::./CreateAccount.png[SwarmLab Register] + + +=== Main Register Page + +You will then be presented with a Log On / Register page. Click on register. + +.Click on "Register" +image::./RegisterMain-1.png[SwarmLab Register Main] + +=== Add Personal details + +Next, enter your information and the password you would like to use. + +.Enter your personal details. +image::./CreateAccount-Main.png[SwarmLab Register Main Info] + +[NOTE] +==== +Carefully review the https://api-client.swarmlab.io:8088/#/terms[Terms of Service] + +and **Legal Disclaimer and Notices** + +.Legal Disclaimer and Notices +[source,bash] +---- +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +3. Neither the name of Swarmlab.io nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +---- + +**before you continue.** + +==== + +[NOTE] +==== +Continuing past the next step confirms that you agree to both documents. +==== + + + +=== Verify email address + +The system will send you an account activation email. Follow the directions in the email to complete the registration process. Upon completion of the registration process, you will be able to access SwarmLab Services. + + +.Verify email +[source,bash] +---- +Click the Verify email address button in the message from SwarmLab. + +This confirms your email address and returns you to the sign-up process. +---- + + + + + + + + + + + + +:hardbreaks: + +{empty} + +{empty} + +{empty} + +:!hardbreaks: + +''' + diff --git a/swarmlab/files/help/RegisterMain-1.png b/swarmlab/files/help/RegisterMain-1.png new file mode 100644 index 0000000..22395d2 Binary files /dev/null and b/swarmlab/files/help/RegisterMain-1.png differ diff --git a/swarmlab/files/help/faq.adoc b/swarmlab/files/help/faq.adoc index a0511bd..9e8a91f 100644 --- a/swarmlab/files/help/faq.adoc +++ b/swarmlab/files/help/faq.adoc @@ -12,3 +12,4 @@ For any questions not addressed in this list please do not hesitate to contact our support team! include::./git_help.adoc[] + diff --git a/swarmlab/files/help/git_help.adoc b/swarmlab/files/help/git_help.adoc index 460b215..b38670a 100644 --- a/swarmlab/files/help/git_help.adoc +++ b/swarmlab/files/help/git_help.adoc @@ -1,7 +1,7 @@ == Git -=== http://docs.swarmlab.io/SwarmLab-HowTos/HowTo-register.adoc.html[HowTo-register] +=== http://docs.swarmlab.io/SwarmLab-HowTos/swarmlab/files/help/HowTo-register.adoc.html[HowTo-register] -=== http://docs.swarmlab.io/SwarmLab-HowTos/HowTo-gitea.adoc.html[HowTo-create Repo] +=== http://docs.swarmlab.io/SwarmLab-HowTos/swarmlab/files/help/HowTo-gitea.adoc.html[HowTo-create Repo] diff --git a/swarmlab/files/help/repo-2.png b/swarmlab/files/help/repo-2.png new file mode 100644 index 0000000..50d1e94 Binary files /dev/null and b/swarmlab/files/help/repo-2.png differ diff --git a/swarmlab/files/help/repo-clone-1.png b/swarmlab/files/help/repo-clone-1.png new file mode 100644 index 0000000..0398000 Binary files /dev/null and b/swarmlab/files/help/repo-clone-1.png differ