Skip to content

Doc/rocketpy hackathon tutorial github link update #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 26, 2022
Merged

Doc/rocketpy hackathon tutorial github link update #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b36ee6d
DOC: fix external link
brunosorban Aug 26, 2022
c04ae95
s
Aug 26, 2022
567ca61
Merge branch 'doc/rocketpy-hackathon-tutorial' of https://github.com/…
Aug 26, 2022
e9cf379
DOC: update hackaton repository link in git documentation
phmbressan Aug 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/development/github_tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ First and foremost, the participant must open a terminal session and change the

```sh
cd <your_desired_path>
git clone https://github.com/Projeto-Jupiter/RocketPy-Hackathon-2022.git
git clone https://github.com/RocketPy-Team/RocketPy-Hackathon-2022.git
```

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

### Forks

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:
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:

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

Expand Down
10 changes: 5 additions & 5 deletions docs/development/rocketpy_as_developer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Preparing directory for code editing
====================================

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.
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:
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:

.. code-block:: console

Expand Down Expand Up @@ -124,7 +124,7 @@ The motor class contains information about the thrust curve and uses some geomet
.. code-block:: python

Pro75M1670 = SolidMotor(
thrustSource="../data/motors/Cesaroni_M1670.eng",
thrustSource="../data/motors/Cesaroni_M1670.eng", #copy here the path to the thrust source file
burnOut=3.9,
grainNumber=5,
grainSeparation=5 / 1000,
Expand Down Expand Up @@ -158,8 +158,8 @@ The first step is to initialize the class with the vital data:
inertiaZ=0.0351,
distanceRocketNozzle=-1.255,
distanceRocketPropellant=-0.85704,
powerOffDrag="../../data/calisto/powerOffDragCurve.csv",
powerOnDrag="../../data/calisto/powerOnDragCurve.csv",
powerOffDrag="../../data/calisto/powerOffDragCurve.csv", #copy here the path to the drag curve file
powerOnDrag="../../data/calisto/powerOnDragCurve.csv", #copy here the path to the drag curve file
)

Then the rail buttons must be set:
Expand Down Expand Up @@ -252,5 +252,5 @@ For example, to access Flight class parameters, you can use:

help(Flight)

More documentation materials can be found at [read the docs](https://docs.rocketpy.org/en/latest/?badge=latest).
More documentation materials can be found at `read the docs <https://docs.rocketpy.org/en/latest/?badge=latest>`_.
It can also be found on RocketPy's GitHub page on the badge "docs".