Giter Club home page Giter Club logo

junodocs.jl's Introduction

JunoDocs

Developer Chat Travis Docs Docs

This is the documentation for the Juno IDE, hosted at http://docs.junolab.org. It is created using Documenter.jl

Contributing to the Documentation

In order to contribute to the documentation, simply modify the files in the /docs/src folder and open a PR against the master branch. Once a PR has been opened, the CI will automatically run Documenter.jl and generate a new documentation against the PR. You can see the generate documentation on http://docs.junolab.org/previews/PR##, where ## is the PR number.

Local build of the Documentation

Although it's not necessary, if you want to check how the new documentation pages would look like in advance of opening a PR, you can build documentations locally and check the results generated in docs/build by the following step:

from the root of this repository:

$ julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path = pwd())); Pkg.instantiate()'
$ julia --project=docs/ docs/make.jl

junodocs.jl's People

Contributors

aaowens avatar anadrome avatar archiecall avatar aviatesk avatar azamatb avatar balinus avatar chrisrackauckas avatar datseris avatar egnha avatar femtocleaner[bot] avatar heliosdrm avatar infi-knight avatar jlewis91 avatar jobjob avatar joshdoug avatar lilithhafner avatar logankilpatrick avatar mbaz avatar metanoid avatar mikeinnes avatar nicholaswmritchie avatar p-i- avatar pfitzseb avatar scimas avatar sebastianm-c avatar simonbyrne avatar timholy avatar waldyrious avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

junodocs.jl's Issues

Atom remote access sometimes only saves to temporary local files without changing the real remote files.

I'm not sure if this is the right place to complain about remote access issues. In general, I really appreciate that if I lost connection to remote or accidentally shut down Atom, it preserves my open tabs. However, there is this issue where if you leave remote files open on Atom when you shut it down, it opens them up from the local temporary files before you specify where you want to remote access, and then do not connect those open local files with the remote ones.

This has been a real problems for me as I have, on several occasions, thought that I was accessing remote files, when I was actually saving to local files, which made debugging programs that frequently crash and require restarting more confusing for me than usual. I also once lost a month of work when I opened a remote file and it overrode the temporary local file I didn't realize I was actually saving to.

I understand that this could be an issue if users modified the remote files through a different remote access in-between remote Atom sessions. However, is there any way to make temporary files sync with identical remote versions, and prevent temporary files from being overridden by remote files if their content differs?

Write about Juno's CI

@MikeInnes mentioned that there's a whole new CI thing, so it would be nice to detail that. I made a blank page for it, just add the Markdown to /docs/src/devdocs/juno_ci.md

Julia Remote not working

Hi,

When I try to use Juno on a remote server I am only able to use a remote REPL and edit the remote files. My Juno won't display the variables in the workspace or evaluate expressions using ctrl+enter, I have to type include("filename") to run the codes. Does anyone know what might be happening?

Thanks!

Add EOL notification

Should there be a warning on the docs or website that says there's a new IDE folks should be using?

Document debugger better (breakpoints, etc.)

The current documentation is three short paragraphs and a gif. An example of how to set a breakpoint (including how to import/use/include the code where the breakpoint will go) would be great in avoiding false starts.

Document what branch to edit when contributing

I came here to propose a change from Ctrl+, to Ctrl+, or Ctrl + , in installation.md, because the comma is easy to miss next to the plus sign, but I wasn't able to figure out what branch one is supposed to edit from the instructions in the README. Both master and gh-pages seem to have been edited recently, so it isn't clear which one should be edited.

In any case, it's always nicer to be explicit :)

How to actually use Juno with remote Julia session? Is REPL supported? If not, what is supported?

I have followed the http://docs.junolab.org/latest/man/faq.html#Connecting-to-an-external-julia-session-on-a-remote-machine-1 and got the confirmation (on both Atom and system notificator), that I have successfully connected with the remote Julia session.

Yet when I try to start REPL I get an atom warning "Can't boot Julia with a Julia client running. Stop the current client with Packages โ†’ Julia โ†’ Stop Julia.". When I do this and open Julia again, I get the local Julia session in the REPL pane.

If it is not a bug but a feature, please update the manual (or I can do this, once you explain it) with the information about what functionality is supported when working on the remote Julia session, and how to use it.

Shortcut documentation for Shift+Enter

By chance, I found that Shift+Enter was a shortcut that let me execute a line or a code block and move the curser to the next line/block. I was looking for this short-cut long ago and could not find it in the Juno documentation. Would you mind putting it there? Are there other "hidden" shortcuts?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.