august heartbeat #2723

jendefig · 2021-08-16T15:01:50Z

Here's the August Heartbeat. I'd like this to go out today/tonight if possible because I'd like to include it in tomorrow's monthly email.

Need help with Docs updates. Per @daavoo's excellent suggestion, I will be incorporating Doc updates monthly in the Heartbeat. Let me know how I should edit this section. There are probably important things from the last couple months that I should include and haven't. My plan for the Twitter swag grab is to ask people to put the doc updates in the comments. 😁 🤫

Also please help with the section about @isidentical's project. I do not understand what this is, so I don't know how to make this better. 😬

content/blog/2021-08-16-august-21-dvc-heartbeat.md

Co-authored-by: Batuhan Taskaya <[email protected]>

iesahin

Thank you @jendefig Great stuff as always 💯

content/blog/2021-08-16-august-21-dvc-heartbeat.md

jorgeorpinel · 2021-08-17T08:53:45Z

content/blog/2021-08-16-august-21-dvc-heartbeat.md

+## Docs Updates
+
+This month we are introducing docs updates! We will be including this in each
+month's Heartbeat so that you will always be aware of the what has changed as


Can you remind us the rationale behind sharing docs updates via blog? ~~I'm not opposed but~~ I'd like to discuss the scope with the team. The current list below is more detailed than what we even share internally with the company 🙂

I originally suggested that we should communicate somehow the docs improvements being added. However I don't have a strong opinion on where (hearbeat, blog post, other) or how to aggregate the updates.

Although I agree partially with:

all content should organically reach readers via search engines, support channels, etc

I think that docs should showcase/promote their updates similar to how releases work for software (i.e. DVC/CML), where users can see a summary of the changes being added recently.

I don't think it's realistic to expect that an user looking for info will be periodically re-searching the docs for updates or re-asking in support channels. In my experience, when you have a need, you look for info at one point in time and just deal with what it is published at that moment.

A real example:

Last week I was looking for info regarding sharing experiments. I found a section in Getting Started and then just the command reference. I used that succinct info and tried things by myself. My life would have been easier if I had access to the Sharing Experiments User Guide, which got merged a few days before my initial search.

I just notice that new guide because I was contributing to dvc.org and it happened to be an Open P.R. at the same time I checked the P.Rs. page.

If I were an external user, how would I noticed this change that helped me?

@jorgeorpinel

I don't think it's realistic to expect that an user looking for info will be periodically re-searching the docs for updates or re-asking in support channels. In my experience, when you have a need, you look for info at one point in time and just deal with what it is published at that moment.

I agree with this assesment by @daavoo . And so it could be helpful to point out some of our changes. My list may be more detailed - that's why I need help with what should be here.

I've heard now repeatedly from our Community that it seems people get things working for them and then may not check back. Even our champions that love us and use our tools: João - didn't know about Studio functionality, Sami and not using the experiments, I'm forgetting who, but someone using DVC, but yet to implement CML, though they want to. All these people are busy making things right in their own teams. To give them a monthly update on things that may make their lives easier is a very good idea. (to the extent that they actually read Heartbeat - but adding this info may help drive more Heartbeat views)

@jorgeorpinel I also think where Community members contribute significantly to docs changes we should shout that out too which is why a included @ meirale. This will a.)recognize their contribution and b.) encourage more contribution.

I don't think it's realistic to expect that an user looking for info will be periodically re-searching the docs

@daavoo @jendefig yes but then it's also not realistic that they'll look in the blog for the same info.

Writing/reviewing this takes some effort so I think it's best to have a clear reason or problem we're solving with this.

The question of how many website users are docs regulars and for what reasons they come back is interesting (I would assume mainly they return to the cmd/api refs.) but it's still not clear to me how we would serve them with these updates via blog. Do they even overlap with blog readers?

I think that in blog updates we should highlight actual product updates instead, and link to the new/improved docs that usually accompany those feature releases. That (which we already do probably) feels more natural to me.

to the extent that they actually read Heartbeat

Exactly. So maybe it's a matter of having a social-media friendly summary of heartbeats to post on Discord/Twitter threads along with a link to the full article. But that's up to @iterative/devrel I think.

where Community members contribute significantly to docs changes we should shout that out too which is why a included @ meirale

I like that idea but it could just be those docs updates we include in the heartbeat as part of the community section. BTW how will that person know he was mentioned?

p.s. guys feel free to include in a minute and join that docs meeting when you can if you'd like to discuss this with the whole team 🙂

Quick recap on this: I believe we agreed to mark certain docs updates in our internal reports as "may be worth sharing with the community" and let #devrel take it from there. Thanks

… into august-heartbeat

jorgeorpinel

Suggestions to make this mergeable. We can continue to discuss on docs updates scope after.

content/blog/2021-08-16-august-21-dvc-heartbeat.md

jendefig · 2021-08-17T23:49:06Z

@jorgeorpinel @shcheklein I don't know what's going on with the links check. They are correct and go where they are supposed to. 🤷🏻‍♀️ This is ready to merge.

jorgeorpinel

I don't know what's going on with the links check. They are correct

@jendefig The check's name is misleading. It checks all URLs, not just links. In this case it's complaining about 2 images:

jorgeorpinel · 2021-08-18T00:24:52Z

content/blog/2021-08-17-august-21-dvc-heartbeat.md

+complex concepts doesn't thrill you, the links to no less than 63 (😱) resources
+will get you on your way to data-centric nirvana.
+
+![Data Centric Framework](/uploads/images/2021/08-17/lj-miranda-data-centric.png)


Before I merge, let me post here what the actual URL paths are rendered in the review app for the record.
For this one it's

/static/6cfa523455e454fb01e9f7fabb1cf96f/fa73e/lj-miranda-data-centric.webp

jorgeorpinel · 2021-08-18T00:25:33Z

content/blog/2021-08-17-august-21-dvc-heartbeat.md

+[**this survey**](https://docs.google.com/forms/d/e/1FAIpQLSdmwjs0ZkxDdODfZTvSwP2bVW4JAVVdxiYhQPyW5dSbsZC8qg/viewform?pli=1)
+to help us plan! 🙏🏼
+
+![DVC Online Course survey](/uploads/images/2021/08-17/survey.png) _Help us plan


And this one.

But I see they both render properly in https://dvc-org-august-heartbea-moy8x7.herokuapp.com/blog/august-21-dvc-heartbeat so yeah we're good to merge here.

The actual URL rendered for this one is

/static/83fdf48f7311c67c558afe07fa5a639b/fa73e/survey.webp

BTW what is this /uploads -> /static thingy? I suspect @rogermparent and/or @casperdcl may know.

We need to update the link checker to support or ignore this.

BTW what is this /uploads -> /static thingy? I suspect @rogermparent and/or @casperdcl may know.

I believe this is due to Gatsby image processing, since the resulting imageset isn't at the same path as the original.

We need to update the link checker to support or ignore this.

Yeah, probably, ignoring all MD image URLs would be the most obvious solution, and I don't think there doing so would clobber anything since we process all MD images now.

iterative/link-check#9

I see #2723 (review) was addressed.

jorgeorpinel · 2021-08-18T01:13:29Z

⚠️ Dayum looks like this didn't build on prod. Error log:

       Uploading ".cache" to s3://.../...-prod-cache/
       ".cache" uploaded in: 37.430s
       "public" uploaded in: 52.502s
       Cleaning all local cache!
Error: CloudFlare cache clear request returned non-ok status 403: Forbidden
    at module.exports (/tmp/build_b1fb9cb4/scripts/clear-cloudflare-cache.js:52:11)
    at runMicrotasks (<anonymous>)
    at processTicksAndRejections (node:internal/process/task_queues:94:5)
    at async main (/tmp/build_b1fb9cb4/scripts/deploy-with-s3.js:136:5)
error Command failed with exit code 1.
       info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
-----> Build failed

Yelp @rogermparent @julieg18 is this maybe related to the images mentioned under #2723 (review) above?

august heartbeat

48bceb5

shcheklein temporarily deployed to dvc-org-august-heartbea-moy8x7 August 16, 2021 15:02 Inactive

jendefig requested a review from jorgeorpinel August 16, 2021 15:02

isidentical reviewed Aug 16, 2021

View reviewed changes

content/blog/2021-08-16-august-21-dvc-heartbeat.md Outdated Show resolved Hide resolved

corrected cover image path

aa5324d

shcheklein temporarily deployed to dvc-org-august-heartbea-moy8x7 August 16, 2021 15:39 Inactive

Update content/blog/2021-08-16-august-21-dvc-heartbeat.md

1a52f4e

Co-authored-by: Batuhan Taskaya <[email protected]>

shcheklein temporarily deployed to dvc-org-august-heartbea-moy8x7 August 16, 2021 15:53 Inactive

jendefig requested review from casperdcl, daavoo and iesahin August 16, 2021 22:00

iesahin previously requested changes Aug 17, 2021

View reviewed changes

content/blog/2021-08-16-august-21-dvc-heartbeat.md Outdated Show resolved Hide resolved

content/blog/2021-08-16-august-21-dvc-heartbeat.md Outdated Show resolved Hide resolved

jorgeorpinel reviewed Aug 17, 2021

View reviewed changes

jendefig added 3 commits August 17, 2021 07:55

Emre's changes and date changes

0857ff1

Merge branch 'august-heartbeat' of https://github.com/iterative/dvc.org…

fd81396

… into august-heartbeat

Emre's adjustments and date changes

dd8bc84

shcheklein temporarily deployed to dvc-org-august-heartbea-moy8x7 August 17, 2021 15:30 Inactive

corrected name of file to hopefully get rid of link problem

1ed96ef

shcheklein temporarily deployed to dvc-org-august-heartbea-moy8x7 August 17, 2021 21:54 Inactive

jorgeorpinel approved these changes Aug 17, 2021

View reviewed changes

content/blog/2021-08-16-august-21-dvc-heartbeat.md Outdated Show resolved Hide resolved

content/blog/2021-08-16-august-21-dvc-heartbeat.md Outdated Show resolved Hide resolved

updating docs section

2bbf8e1

shcheklein temporarily deployed to dvc-org-august-heartbea-moy8x7 August 17, 2021 22:27 Inactive

correcting my typos

d0c23eb

shcheklein temporarily deployed to dvc-org-august-heartbea-moy8x7 August 17, 2021 23:23 Inactive

jorgeorpinel reviewed Aug 18, 2021

View reviewed changes

jorgeorpinel merged commit c7f69c5 into master Aug 18, 2021

jorgeorpinel mentioned this pull request Aug 18, 2021

blog: remove accidental doc update #2728

Merged

jorgeorpinel assigned jendefig Aug 18, 2021

casperdcl deleted the august-heartbeat branch August 18, 2021 08:58

jorgeorpinel mentioned this pull request Aug 25, 2021

support /uploads -> /static link checks iterative/link-check#9

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

august heartbeat #2723

august heartbeat #2723

jendefig commented Aug 16, 2021 •

edited

Loading

iesahin left a comment

jorgeorpinel Aug 17, 2021 •

edited

Loading

daavoo Aug 17, 2021

jendefig Aug 17, 2021 •

edited

Loading

jendefig Aug 17, 2021

jorgeorpinel Aug 18, 2021 •

edited

Loading

jorgeorpinel Aug 18, 2021

jorgeorpinel Aug 18, 2021 •

edited

Loading

jorgeorpinel Aug 18, 2021

jorgeorpinel left a comment

jendefig commented Aug 17, 2021

jorgeorpinel left a comment

jorgeorpinel Aug 18, 2021

jorgeorpinel Aug 18, 2021 •

edited

Loading

jorgeorpinel Aug 18, 2021

jorgeorpinel Aug 18, 2021

jorgeorpinel Aug 18, 2021

jorgeorpinel Aug 18, 2021 •

edited

Loading

rogermparent Aug 19, 2021

jorgeorpinel Aug 25, 2021

jorgeorpinel commented Aug 18, 2021 •

edited

Loading

august heartbeat #2723

august heartbeat #2723

Conversation

jendefig commented Aug 16, 2021 • edited Loading

iesahin left a comment

Choose a reason for hiding this comment

jorgeorpinel Aug 17, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jendefig Aug 17, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel Aug 18, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel Aug 18, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel left a comment

Choose a reason for hiding this comment

jendefig commented Aug 17, 2021

jorgeorpinel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel Aug 18, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel Aug 18, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel commented Aug 18, 2021 • edited Loading

jendefig commented Aug 16, 2021 •

edited

Loading

jorgeorpinel Aug 17, 2021 •

edited

Loading

jendefig Aug 17, 2021 •

edited

Loading

jorgeorpinel Aug 18, 2021 •

edited

Loading

jorgeorpinel Aug 18, 2021 •

edited

Loading

jorgeorpinel Aug 18, 2021 •

edited

Loading

jorgeorpinel Aug 18, 2021 •

edited

Loading

jorgeorpinel commented Aug 18, 2021 •

edited

Loading