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

Jump to bottom

Update documentation with more detailed installation instructions, requirements and more #4382

Merged

JerBouma merged 29 commits into develop from hotfix/new_docs_buttons

Mar 9, 2023

Contributor

jose-donato commented Mar 2, 2023 •

edited by JerBouma

Loading

Update:

Scripts and Routines
Basics guide
Installation guides, a page per guide and much more detailed.
Requirements, remove it and add it to installation docs.
Import and export data
Restructured both menus


          fix: changed button styles

240b106

jose-donato added the docs label

jose-donato requested a review from JerBouma

March 2, 2023 17:04

reviewpad bot added the feat XS label

jose-donato changed the title ~~fix: changed button styles~~ Docs - changed button styles

Contributor

JerBouma commented Mar 2, 2023

Noice, I'll make some additional changes tomorrow then ready to merge.


          Make Rosetta requirements more clear

461c4df

Contributor

JerBouma commented Mar 3, 2023 •

edited

Loading

Changed docs:

Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1) . **Apple Silicon users will need to install Rosetta prior to installation**. 

Installing Rosetta can be done with the following steps:

1. Press ⌘ (Command) + SPACE to open spotlight search, and type `Terminal` and hit Return (⏎).
2. Copy and paste the following code in the Terminal and hit ENTER (⏎):
   ```console
   softwareupdate --install-rosetta
   ```
3. This will start up the Rosetta installation process and you will receive a message regarding the Licence Agreement. Type `A` and hit Return (⏎).
4. After the installation process has finished, you can proceed t the "Mac M1 Installer" button.

To understand whether you are using an Apple Sillicon (M1) device or an Intel-based device click on the Apple Icon at the top left of your MacBook and select "About This Mac". Then under "Chip" if it says something like "Apple M1 Pro" or "Apple M1 Max", you know you have an Apple Silicon MacBook. If it says for example "2,3 GHz Quad-Core Intel Core i7" you know that you have an Intel-based MacBook and you can continue by clicking on the "Mac Intel Installer" button.

There are some unanswered questions before we proceed:

Contributor

JerBouma commented Mar 6, 2023

Hijacking your PR a bit to get some more doc changes in.

JerBouma changed the title ~~Docs - changed button styles~~ Update documentation with more detailed installation instructions, requirements and more

JerBouma added 2 commits

March 6, 2023 13:22


          Merge branch 'develop' into hotfix/new_docs_buttons

fac859c


          Update installation instructions

769b6f6

reviewpad bot added feat M and removed feat XS labels


          Add seperation

2b80f55

reviewpad bot added feat L and removed feat M labels

JerBouma and others added 9 commits

March 6, 2023 15:49


          Update windows.md

2f7f4c3


          Update installation docs

c8a9408


          fix country choices (#4403)

1fc633b


          Hotfix/plotsbackend start (#4404)

45e4f8b

* readd removed plots_backend().start() from merged PR

* Update backend.py

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>


          Update helper_classes.py (#4378)

1d22396

Co-authored-by: James Maslek <jmaslek11@gmail.com>


          Add improvements to the website

e83648f


          Fix keys wrong redirect

8ad742d


          Update installation

313908e


          Update requirements

bf62fd4

Contributor

JerBouma commented Mar 6, 2023

@jose-donato Can you look into making it so clicking on "Installation" sends you to your OS? And can you see what the issue is with the MacOS buttons?

JerBouma added 3 commits

March 6, 2023 21:08


          Merge branch 'develop' into hotfix/new_docs_buttons

f5778f6


          move things around

1c1c628


          Restructure everything

58cc00d

reviewpad bot suggested changes

View reviewed changes

reviewpad bot left a comment

The dependency tree has been changed. Please update requirements.txt and requirements-full.txt


          Merge branch 'develop' into hotfix/new_docs_buttons

reviewpad bot suggested changes

View reviewed changes

reviewpad bot left a comment

The dependency tree has been changed. Please update requirements.txt and requirements-full.txt

Contributor Author

jose-donato commented Mar 7, 2023

Screenshare.-.2023-03-07.1_07_36.PM.mp4


          fix: mac issue and redirect installation

db013cf

reviewpad bot suggested changes

View reviewed changes

reviewpad bot left a comment

The dependency tree has been changed. Please update requirements.txt and requirements-full.txt


          Merge branch 'develop' into hotfix/new_docs_buttons

9e9c63c

reviewpad bot suggested changes

View reviewed changes

reviewpad bot left a comment

The dependency tree has been changed. Please update requirements.txt and requirements-full.txt


          fix: mac macos

966e2f6

reviewpad bot suggested changes

View reviewed changes

reviewpad bot left a comment

The dependency tree has been changed. Please update requirements.txt and requirements-full.txt


          Remove installation .md and make it dropdown

c66fea5

reviewpad bot suggested changes

View reviewed changes

reviewpad bot left a comment

The dependency tree has been changed. Please update requirements.txt and requirements-full.txt


          Update installation of SDK

60beccf

reviewpad bot suggested changes

View reviewed changes

reviewpad bot left a comment

The dependency tree has been changed. Please update requirements.txt and requirements-full.txt


          Grammar

25df9fd

reviewpad bot previously requested changes

View reviewed changes

reviewpad bot left a comment

The dependency tree has been changed. Please update requirements.txt and requirements-full.txt

JerBouma dismissed reviewpad[bot]’s stale review

March 8, 2023 13:51

It hasn't been changed, these are just documentation changes.


          Merge branch 'develop' into hotfix/new_docs_buttons

f6b2e32

JerBouma requested a review from jmaslek

March 8, 2023 13:53

Contributor

JerBouma commented Mar 8, 2023 •

edited

Loading

@jmaslek Just asking you to look at it because reviewpad is whining. These are just upgrades to the Docs. The auto-select installation page has been taken out (so Jose's video is irrelevant).

JerBouma and others added 2 commits

March 9, 2023 08:15


          Merge branch 'develop' into hotfix/new_docs_buttons

27f164b


          Merge branch 'develop' into hotfix/new_docs_buttons

367543b

jmaslek approved these changes

View reviewed changes

Collaborator

jmaslek commented Mar 9, 2023

@jmaslek Just asking you to look at it because reviewpad is whining. These are just upgrades to the Docs. The auto-select installation page has been taken out (so Jose's video is irrelevant).

looks fine to me

JerBouma enabled auto-merge

March 9, 2023 16:57

JerBouma added this pull request to the merge queue

Merged via the queue into develop with commit 9211a85

piiq deleted the hotfix/new_docs_buttons branch

March 22, 2023 14:03

jmaslek added a commit that referenced this pull request


          Update documentation with more detailed installation instructions, re…

f043420

…quirements and more (#4382)

* fix: changed button styles

* Make Rosetta requirements more clear

* Update installation instructions

* Add seperation

* Update windows.md

* Update installation docs

* fix country choices (#4403)

* Hotfix/plotsbackend start (#4404)

* readd removed plots_backend().start() from merged PR

* Update backend.py

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>

* Update helper_classes.py (#4378)

Co-authored-by: James Maslek <jmaslek11@gmail.com>

* Add improvements to the website

* Fix keys wrong redirect

* Update installation

* Update requirements

* move things around

* Restructure everything

* Details

* fix: mac issue and redirect installation

* fix: mac macos

* Remove installation .md and make it dropdown

* Update installation of SDK

* Grammar

---------

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: teh_coderer <me@tehcoderer.com>
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels