Documentation for quickstart guide#12
Open
eric-ott wants to merge 18 commits into
Open
Conversation
-Tip at the top fixed - Only runs on java 17, link to download Java -link to Gradle
Did not know :::Tip did something, so I reverted it back to it
1. added instructions, that they will be using the HTTPS to add more clarity in what they are doing 2. Added language in the second half, to make it clearer to show exactly what they are doing. 3. Added directions to where the file is, so they know where they are going without knowledge about paths.
4. Rewrote "How to Build an OSH Node", adding a section that tells the user where they should be starting, to where they should be ending
1. In Deploying OSH Node, I added an overview section, to explain what is happening and give the starting point and ending point 2. Instructions on how to unzip a file in the command line. (there may be different unzip commands, but from a google search it says they use the same command, but I may be wrong here) 3. Clearer on opening your node on a browser. 4. Moved the username, password and example picture up, right under where you are reading about opening up your localhost, fits better there. 5. Clarified, that this is the defualt OSH node, and later we will explain how to customize it for your own project
- I added instructions on how to end your node and restart it, once you have your folder made. I was unable to use the existing instructions to do this, so I played around with it in my IDE, and this was the solution I came up with. (This is likely not the most effienct method, but it is the method I used to do it on my own)
…rom playing with the code more.
…operly do what you want to do with it 2. simplified the settings.gradle part, to understand how to use it 3. simplified build.gradle to how to use it. NEED TO DO: understand fully how projects work, subprojects. what is the dist, inclu subprojects it comments on addings submoduled, meaning? USE AI TO EXPLAIN HOW IT WORKS SO YOU CAN LEARN
…ons and core. 2. Added an example section that describes how to add fakeweather driver, and how to reluanch the folder so you have the addons. STILL NEED TO LOOK UP THE 3 QUESTIONS IN NOTEBOOK
|
@eric-ott is attempting to deploy a commit to the Alex Almanza's projects Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I went through to add my edits to the OSH-docs, reviewing the Quickstart section. When I thought it was going to be an easy fix, to quickly added edits as I worked through what it was trying to get me to do, I kept having several problems, so I worked through those errors, took notes on them, and attempted to fix the documentation so that someone in the future can work through it easier.
This accompanies "OSH-docs, documentation for Quickstart Guide" in my team tracker, with notes on the problems, fixes, and comments made for each of the 5 sections I worked through.
These fixes are solutions I developed through trial and error, which worked for me. While they may not be the most efficient method, they were effective solutions I found by either working through them myself or learning from the team's software engineers.
All additional comments I have about updates made in this PR will be found in my team tracker, which is broken down by each of the 5 sections, as subproblems, with notes about the things I added/fixed.