Skip to content
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.

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

Comparisons, Julia/BioJulia installation sections + devcontainer #9

Merged
merged 5 commits into from
Aug 9, 2023

Conversation

M-PERSIC
Copy link
Member

@M-PERSIC M-PERSIC commented Aug 9, 2023

  • Add scikit-bio, BioPerl, BioRuby, and BioJava comparison sections
  • Finish julia/biojulia installation sections (have some more ideas for showing off vscode commands however it is ready for MVP)
  • Initial skeleton section template for case scenarios (day in the life of a teacher, researcher, etc. and how they use Julia)
  • Add devcontainer schema

closes #2

@M-PERSIC M-PERSIC marked this pull request as draft August 9, 2023 18:39
@M-PERSIC M-PERSIC marked this pull request as ready for review August 9, 2023 18:44
@M-PERSIC M-PERSIC requested a review from kescobo August 9, 2023 18:44
@M-PERSIC
Copy link
Member Author

M-PERSIC commented Aug 9, 2023

Ah one moment I found something interesting! All good

@M-PERSIC M-PERSIC marked this pull request as draft August 9, 2023 18:47
@M-PERSIC M-PERSIC marked this pull request as ready for review August 9, 2023 18:47
@kescobo
Copy link
Member

kescobo commented Aug 9, 2023

Preview build: https://biojulia.dev/BioJuliaDocs/previews/PR9/

There's some way to get this automatically posted to the thread or in the merge checks when it's build, but I can't remember.

@M-PERSIC
Copy link
Member Author

M-PERSIC commented Aug 9, 2023

If it's a GitHub action, it should be easy to add. I added a note to the README on how to deploy locally (open up the website in localhost) so anyone can see their changes before submitting a pr

Copy link
Member

@kescobo kescobo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good!

docs/src/getting_started/toolsinstallation.md Show resolved Hide resolved
equivalent of Python3's `if __name__ == __main__` condition would be `if abspath(<name of program file>) == @__FILE__`

!!! warning
One common footgun with the Julia REPL is that there are currently certain code changes that cannot be performed without
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Though "footgun" is a great phrase, it's probably less accessible for non-native speakers or folks new to development.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about "a common gotcha"?

docs/src/getting_started/toolsinstallation.md Show resolved Hide resolved
@M-PERSIC
Copy link
Member Author

M-PERSIC commented Aug 9, 2023

I'll make a quick second pr for some changes.

@M-PERSIC M-PERSIC merged commit b276171 into main Aug 9, 2023
1 check passed
@M-PERSIC M-PERSIC deleted the dev branch August 9, 2023 21:39
M-PERSIC added a commit that referenced this pull request Aug 9, 2023
Add some quick fixes suggested in #9.

Attempted to add them in the original pr, but Git was raising hell on my local machine and this was a great opportunity to try the devcontainer via codespaces
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a dev container definition
2 participants