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

Begginers guide #205

Merged
merged 8 commits into from
Oct 7, 2021
Merged

Begginers guide #205

merged 8 commits into from
Oct 7, 2021

Conversation

rosscastle
Copy link
Contributor

First draft of the beginners guide I have been writing. Please suggest any changes.

Isca beginners documentation V1.

Trying out the github upload method.
Update index file
Added links to the ReadMe and Neil's experiment guide - which is fantastic and I wish I knew about it sooner!
Added link to Isca paper and Isca website
@rosscastle rosscastle requested review from daw538 and mckimb May 19, 2021 10:18
@daw538
Copy link
Contributor

daw538 commented May 19, 2021

Looks pretty good to me, just a couple of suggestions:

Firstly, I think it should be Beginner's guide (not Begginer) 😉 (though I now notice this appears to just apply to the filename)

There are a couple of places in the text where another section is referenced such as (L47)

In the future it may be useful to have python environments (see 'Conda' in 'Intermediate').

I think it would be good if these were directly linked in the text, which I think you can do with like this (for reference it's done by appending #<section> to the page URL).

Would it be worth stating (perhaps in the file transfer section) that it is also possible to view and transfer files using the native file browser if you're using UNIX or OSX, using their built-in functions to connect via SFTP? I'm thinking this might make navigating around and looking at isca's file structure a bit easier for those not familiar with command line (although tbf it's how I normally navigate about anyway).

Also, though I know this will be quite a subjective view, but could we also suggest nano as a possible text editor? It's available on pretty much every unix system and I think offers a useful middle ground between gedit and vim, which I'd say are at opposite ends of the useability/interface scale.

Other than that, nice work!

Added info about native file browsers on linux/macOS when viewing/transferring files.
Added links in the document to the relevant sections. e.g. see Conda in Advanced.
This is to enable the internal links on the pages.
@rosscastle
Copy link
Contributor Author

Hi @daw538, thanks for your comments, I've sorted everything other than the editor comment as we discussed! I used an internal link on the docs instead of the URL, however this means I had to edit conf.py to allow. @mckimb if you could let me know if you have any comments. Thanks!

@dennissergeev dennissergeev added docs infrastructure Isca infrastructure: installation, CI, HPC setups priority:medium Medium-piority task labels Jun 24, 2021
Copy link
Contributor

@mckimb mckimb left a comment

Choose a reason for hiding this comment

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

Looks good and ready to go!

@mckimb mckimb merged commit 575e8ea into ExeClim:master Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs infrastructure Isca infrastructure: installation, CI, HPC setups priority:medium Medium-piority task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants