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

TauP introduction and install #23

Merged
merged 34 commits into from
Dec 29, 2020
Merged

TauP introduction and install #23

merged 34 commits into from
Dec 29, 2020

Conversation

core-man
Copy link
Member

@core-man core-man commented Dec 21, 2020

Preview: https://software-git-taup-tutorial.seismo-learn.vercel.app

  1. Split TauP tutorial into three parts: brief intro; install; usage
  2. Finish the draft of intro and install
  3. Leave usage TODO

see also #1

@core-man
Copy link
Member Author

@seisman, please comment on the format as I am not very familiar with good rst format writing.

@seisman
Copy link
Member

seisman commented Dec 21, 2020

Looks good. Shall we split the content into several smaller files?

@seisman seisman mentioned this pull request Dec 21, 2020
@core-man
Copy link
Member Author

yes, it is a little long for a single file. maybe it is better to split into several files in the next commit.

We may also make a rule about the best length and hard limit one of a simple file, which may be included in the template #24 .

@core-man core-man removed the request for review from seisman December 21, 2020 16:35
source/taup.rst Outdated Show resolved Hide resolved
source/taup.rst Outdated Show resolved Hide resolved
source/taup.rst Outdated Show resolved Hide resolved
source/taup.rst Outdated Show resolved Hide resolved
- Install openjdk instead of java in macOS
- Merge apt install default-jre and default-jdk
- Don't apt ungrade in Ubuntu
- Don't use TAUPHOME in .bashrc
Now we have three parts
- introduction
- install
- usage

Usage is also splited into several files.
@seisman
Copy link
Member

seisman commented Dec 24, 2020

Perhaps we should always use lower case names for directories?

https://software-git-taup-tutorial.seismo-learn.vercel.app/TauP/install/ looks a little weird.

.gitignore Outdated Show resolved Hide resolved
source/taup/intro.rst Outdated Show resolved Hide resolved
In this way, we can do each small section at the same time before the final version.
@github-actions
Copy link
Contributor

github-actions bot commented Dec 28, 2020

This comment was written by the Continuous Documentation bot!

@core-man core-man changed the title WIP: TauP tutorial TauP tutorial Dec 28, 2020
@core-man core-man changed the title TauP tutorial TauP introduction and install Dec 28, 2020
@seisman
Copy link
Member

seisman commented Dec 28, 2020

Preview: https://seismo-learn.org/sitepreview/seismo-learn/software/TauP-tutorial/taup/

Two thoughts/questions:

  1. Should we move the software metadata to the index page?
  2. Do we really need to show the TOC in the index page?

source/taup/intro.rst Outdated Show resolved Hide resolved
source/taup/intro.rst Outdated Show resolved Hide resolved
source/taup/intro.rst Outdated Show resolved Hide resolved
source/taup/intro.rst Outdated Show resolved Hide resolved
source/taup/intro.rst Outdated Show resolved Hide resolved
@core-man
Copy link
Member Author

good suggestion. It seems good to hide toc in index since we can see them in side bar. in this way, we should move metadata to index

source/taup/introduction.rst Outdated Show resolved Hide resolved
source/taup/introduction.rst Outdated Show resolved Hide resolved
source/taup/introduction.rst Outdated Show resolved Hide resolved
source/taup/install.rst Outdated Show resolved Hide resolved
source/taup/install.rst Outdated Show resolved Hide resolved
source/taup/install.rst Outdated Show resolved Hide resolved
source/taup/install.rst Outdated Show resolved Hide resolved
core-man and others added 7 commits December 29, 2020 22:44
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Copy link
Member

@seisman seisman 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 to me. 🚀

@core-man
Copy link
Member Author

Okay. Let's move on and come back when some improvements are needed in the future.

@core-man core-man merged commit 4fb9af2 into main Dec 29, 2020
@core-man core-man deleted the TauP-tutorial branch December 29, 2020 15:29
@seisman seisman added the taup label Jan 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants