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

[WIP] New narratives tutorial #139

Merged
merged 1 commit into from
Nov 10, 2022
Merged

Conversation

jameshadfield
Copy link
Member

See nextstrain/nextstrain.org#618 for a review app which this narrative makes use of

@jameshadfield jameshadfield marked this pull request as draft November 4, 2022 01:27
jameshadfield added a commit to nextstrain/narratives that referenced this pull request Nov 9, 2022
Corresponding PR which adds the tutorial to our docs:
nextstrain/docs.nextstrain.org#139
.gitignore Outdated Show resolved Hide resolved

.. [#f2] In practice, the URL path component is what is used to access the dataset relative to the current hostname, however for historical reasons the protocol and hostname must be either ``http://localhost:4000`` or ``https://nextstrain.org``.

.. [#f3] This isn't great from a file-size point of view, and the markdown file isn't nice to look at itself, but it may be the best current solution!
Copy link
Member

@tsibley tsibley Nov 9, 2022

Choose a reason for hiding this comment

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

I've been thinking that a nice user experience would be to have nextstrain remote upload (and any other narrative uploading/editing clients) auto-embed images this way. It makes the narrative self-contained, which is really nice. (Think back to the bad old days when most Word docs didn't embed images in them by default, but merely referenced them on the filesystem. It was bad.)

Copy link
Member Author

Choose a reason for hiding this comment

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

I, happily, do not remember those dark days 😂

Would be a nice user experience for locally referenced images for sure - the alternatives get pretty complicated pretty fast

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, locally available images would be auto-embedded but hotlinked/remote images could be left alone. With a web-based editor, dragging and dropping an image would directly embed (or upload to somewhere we control and then hotlink, but I think this has lots of downsides).

Copy link
Member

@tsibley tsibley left a comment

Choose a reason for hiding this comment

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

Gave a quick skim, found a few issues worth addressing. but overall a nice intro!

src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
@jameshadfield
Copy link
Member Author

Note that I've updated the URLs to point to nextstrain.org/edit/narratives which doesn't actually exist yet. I plan to merge this tutorial once that endpoint does exist.

Copy link
Member

@tsibley tsibley left a comment

Choose a reason for hiding this comment

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

Some minor fixups, but otherwise looks good to me. Love the use of https://nextstrain.org/narratives/how-to-write/basics, including the little bit of science snuck in via postscripts. ;-)

src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
Copy link
Member

@tsibley tsibley left a comment

Choose a reason for hiding this comment

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

One more fixup (last one?? 🤞) and then LGTM.

src/tutorials/narratives-how-to-write.rst Outdated Show resolved Hide resolved
@jameshadfield jameshadfield marked this pull request as ready for review November 10, 2022 02:34
Thanks to @tsibley for review comments
@jameshadfield jameshadfield merged commit 77cc316 into master Nov 10, 2022
@jameshadfield jameshadfield deleted the james/narratives-tutorial branch November 10, 2022 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants