Skip to content

Commit 256f90d

Browse files
Merge pull request #216 from RocketPy-Team/doc/rocketpy-hackathon-tutorial
DOC: rocketpy hackathon tutorial github link update
2 parents 458c5b6 + e9cf379 commit 256f90d

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/development/github_tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ First and foremost, the participant must open a terminal session and change the
2828

2929
```sh
3030
cd <your_desired_path>
31-
git clone https://github.com/Projeto-Jupiter/RocketPy-Hackathon-2022.git
31+
git clone https://github.com/RocketPy-Team/RocketPy-Hackathon-2022.git
3232
```
3333

3434
### Basic Workflow
@@ -59,7 +59,7 @@ A new Pull Request can be made by specifying which changes should be merged into
5959

6060
### Forks
6161

62-
A Fork is a copy of a GitHub repository that allows the user to make changes to a repository while keeping the original unchanged, the changes are updated to the original repository through pull requests. The participant will solve the Challenges and make contributions to a local Fork of the Hackathon GitHub repository, so that it is possible to keep the solutions organized and avoid conflicts that arise from multiple groups editing the same code. It is recommended to use GitHub environment to create a Fork, the participant has to click on the top right corner of the Hackathon GitHub page:
62+
A Fork is a copy of a GitHub repository that allows the user to make changes to a repository while keeping the original unchanged, with changes being updated to the original repository through pull requests. The participant will solve the Challenges and make contributions to a local Fork of the Hackathon GitHub repository, so that it is possible to keep the solutions organized and avoid conflicts that arise from multiple groups editing the same code. It is recommended to use GitHub environment to create a Fork, the participant has to click on the top right corner of the Hackathon GitHub page:
6363

6464
![fork_button](https://docs.github.com/assets/cb-23088/images/help/repository/fork_button.png)
6565

docs/development/rocketpy_as_developer.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Preparing directory for code editing
3131
====================================
3232

3333
You may create a testing file in any directory, but you must remember that they should not be included in the commits and pull requests unless they are part of the proposed solution.
34-
With that in mind, it is suggested the creation of a folder with all the testing files, so they can be added in the .gitignore file, which contains the name of all the files and folders that will not be added to the commits. To create the folder, type on the terminal:
34+
With that in mind, we suggest you to create a folder with all testing files, so they can be added in the .gitignore file, which contains the name of all the files and folders that will not be added to the commits. To create the folder, type on the terminal:
3535

3636
.. code-block:: console
3737
@@ -124,7 +124,7 @@ The motor class contains information about the thrust curve and uses some geomet
124124
.. code-block:: python
125125
126126
Pro75M1670 = SolidMotor(
127-
thrustSource="../data/motors/Cesaroni_M1670.eng",
127+
thrustSource="../data/motors/Cesaroni_M1670.eng", #copy here the path to the thrust source file
128128
burnOut=3.9,
129129
grainNumber=5,
130130
grainSeparation=5 / 1000,
@@ -158,8 +158,8 @@ The first step is to initialize the class with the vital data:
158158
inertiaZ=0.0351,
159159
distanceRocketNozzle=-1.255,
160160
distanceRocketPropellant=-0.85704,
161-
powerOffDrag="../../data/calisto/powerOffDragCurve.csv",
162-
powerOnDrag="../../data/calisto/powerOnDragCurve.csv",
161+
powerOffDrag="../../data/calisto/powerOffDragCurve.csv", #copy here the path to the drag curve file
162+
powerOnDrag="../../data/calisto/powerOnDragCurve.csv", #copy here the path to the drag curve file
163163
)
164164
165165
Then the rail buttons must be set:
@@ -252,5 +252,5 @@ For example, to access Flight class parameters, you can use:
252252
253253
help(Flight)
254254
255-
More documentation materials can be found at [read the docs](https://docs.rocketpy.org/en/latest/?badge=latest).
255+
More documentation materials can be found at `read the docs <https://docs.rocketpy.org/en/latest/?badge=latest>`_.
256256
It can also be found on RocketPy's GitHub page on the badge "docs".

0 commit comments

Comments
 (0)