Docs and illos

[man-shar]

• props
• migration
• using js values in html

[hobbes7878]

FWIW, I'm adding to my personal to do list on the "Thinking with components" doc making a video.

Want to make a simple custom component with folks, from Google doc, to very light interactivity. Should get at mot of the basics folks will encounter and then point to the Svelte tutorial for more details.

Thinking this is the component to make: https://svelte.dev/repl/cce8e20e9bdd4ffd84c2a6595c8e2f9a?version=3.44.0

UPDATE: Added new issue for this: https://github.com/reuters-graphics/bluprint_graphics-kit/issues/44

[man-shar]

yep i think that would be cool. esp if you can get stuff like "Photo", "Caption" as components as well.

[hobbes7878]

Something to add to your todos, once we're done, I'd prefer the images for the developer docs weren't in the statics folder, because those will all get uploaded to RNGS with every project.

There's a neat trick to get github to host your images for you I like to use. Check it out: https://gist.github.com/vinkla/dca76249ba6b73c5dd66a4e986df4c8d

[hobbes7878]

Couple critiques on the new props section of the docs:

I think the example suggests every variable you use in a component is a prop. Probably need to include the export let text; syntax and show the component being used by a parent component as part of that example to make clear the difference.

And a more general thought: I tend not to emphasize "reusability" as much when talking about components with new users. Their usual reaction is "Well, I'm not going to re-use this highly specialized component I'm writing for this one part of this project, so maybe it shouldn't be a component??"

I tend to talk a lot more about "composability," which is like the benefit you get from isolating parts of the page so you can work on them separately and then remix those components easily as the page changes.

Still loving the style of these illos, btw.

[man-shar]

I guess I'll remove the reusabilliity section then. Because the illo introducing components as "parts of a page" already has composability bit.

[man-shar]

Couple critiques on the new props section of the docs:

I think the example suggests every variable you use in a component is a prop. Probably need to include the export let text; syntax and show the component being used by a parent component as part of that example to make clear the difference.

Did not know the "declaring props is necessary" bit about Svelte.

You're right that perhaps I can use that as the first step to introducing usage of javascript variables in html.

[man-shar]

Fuck that's complicated...

[hobbes7878]

Just fyi @man-shar, finished migrating the docs to a new site:
https://reuters-graphics.github.io/docs_graphics-kit/

Repo for that site is here for cloning: https://github.com/reuters-graphics/docs_graphics-kit

And this site has instructions for how to do stuff: https://reuters-graphics.github.io/bluprint_docs-site/

Read the note in that last about using images in markdown, and you can start putting illos in src/statics/images/ instead of that github hack. (Would be good to pull the images out of this repo once everything's been migrated over.)

Lotta links there, but it's pretty easy...

Changes get picked up on the site when you push back to master. Happy doc'ing!

[man-shar]

awesome. will migrate

[man-shar]

alrighty, removed illos from here. and pushed them to the graphics-kit docs repo. Will delete that issue with the dummy images.