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

Update video-series-overview.md #722

Merged
merged 4 commits into from
Aug 14, 2023
Merged

Update video-series-overview.md #722

merged 4 commits into from
Aug 14, 2023

Conversation

alysethurber
Copy link
Collaborator

@alysethurber alysethurber commented Aug 11, 2023

Description

Fixed goals box to be consistent with other note, made all tutorial headers consistent in size, and removed dead link to 'Get started with QGreenland'

Checklist

If an item on this list is done or not needed, check it with [x] or click the
checkbox.

  • The PR description links to issues that it resolves with closes #{issue_number}
  • Config lockfile updated (inv config.export > qgreenland/config/cfg-lock.json)
  • Environment lockfile updated if needed (conda-lock)
  • Version bumped if needed (bumpversion (major|minor|patch|prerelease|build))
  • CHANGELOG.md updated
  • Documentation updated if needed
  • New unit tests if needed

Fixed goals box, made all tutorial headers consistent in size, and removed dead link to 'Get started with QGreenland'
@trey-stafford
Copy link
Contributor

Thanks, @alysethurber! I'll take a look at these changes later. FWIW, I have a PR that updates a lot of the documentation in the works right now. You can take a look here: #711


```
### Goals
```{goals}
Copy link
Contributor

@mfisher87 mfisher87 Aug 11, 2023

Choose a reason for hiding this comment

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

RTD complains about this line:

/home/docs/checkouts/readthedocs.org/user_builds/qgreenland/checkouts/722/doc/user/tutorials/video-series-overview.md:6: ERROR: Unknown directive type "goals".

This syntax looks like you want to do an "admonition". goal isn't a valid one; only the following choices are available:

admonition, attention, caution, danger, error, hint, important, note, tip, warning

You can create one with a custom title like:

```{admonition} My custom title with *Markdown*!
:class: tip

This is tip-style admonition with a custom title.
```

Here the class line sets the style of the admonition to be the same as a tip.

https://myst-parser.readthedocs.io/en/latest/syntax/admonitions.html

Putting it all together, is this what you're shooting for?

```{admonition} Goals
:class: tip

* Learn what data is included in the QGreenland Core Package
* Analyze Greenland data using geoprocessing tools
* Find analysis tools and data relevant to you or your classes
```

Remember that the vertical spacing is really important with these. The "settings" (:class: tip) need to be right after the first line, then they need to be followed by an empty line. If there are no settings, the empty line is still critical.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

THANK YOU! I'll fix that now

Fixed callout box with custom admonition of goals
Copy link
Contributor

@trey-stafford trey-stafford left a comment

Choose a reason for hiding this comment

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

Looks great! There might be some additional tweaks that get made when we merge #711 but I think this can be merged now!

@trey-stafford trey-stafford merged commit bf5e746 into main Aug 14, 2023
2 checks passed
@trey-stafford trey-stafford deleted the alysethurber-patch-1 branch August 14, 2023 21:41
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.

3 participants